126 lines
5.5 KiB
C
126 lines
5.5 KiB
C
/**************************************************************************************************
|
|
Filename: mac_high_level.h
|
|
Revised: $Date: 2011-02-28 16:59:59 -0800 (Mon, 28 Feb 2011) $
|
|
Revision: $Revision: 25230 $
|
|
|
|
Description: Contains interfaces shared between high and low level MAC.
|
|
|
|
|
|
Copyright 2006-2010 Texas Instruments Incorporated. All rights reserved.
|
|
|
|
IMPORTANT: Your use of this Software is limited to those specific rights
|
|
granted under the terms of a software license agreement between the user
|
|
who downloaded the software, his/her employer (which must be your employer)
|
|
and Texas Instruments Incorporated (the "License"). You may not use this
|
|
Software unless you agree to abide by the terms of the License. The License
|
|
limits your use, and you acknowledge, that the Software may not be modified,
|
|
copied or distributed unless embedded on a Texas Instruments microcontroller
|
|
or used solely and exclusively in conjunction with a Texas Instruments radio
|
|
frequency transceiver, which is integrated into your product. Other than for
|
|
the foregoing purpose, you may not use, reproduce, copy, prepare derivative
|
|
works of, modify, distribute, perform, display or sell this Software and/or
|
|
its documentation for any purpose.
|
|
|
|
YOU FURTHER ACKNOWLEDGE AND AGREE THAT THE SOFTWARE AND DOCUMENTATION ARE
|
|
PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
|
|
INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, TITLE,
|
|
NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL
|
|
TEXAS INSTRUMENTS OR ITS LICENSORS BE LIABLE OR OBLIGATED UNDER CONTRACT,
|
|
NEGLIGENCE, STRICT LIABILITY, CONTRIBUTION, BREACH OF WARRANTY, OR OTHER
|
|
LEGAL EQUITABLE THEORY ANY DIRECT OR INDIRECT DAMAGES OR EXPENSES
|
|
INCLUDING BUT NOT LIMITED TO ANY INCIDENTAL, SPECIAL, INDIRECT, PUNITIVE
|
|
OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF PROCUREMENT
|
|
OF SUBSTITUTE GOODS, TECHNOLOGY, SERVICES, OR ANY CLAIMS BY THIRD PARTIES
|
|
(INCLUDING BUT NOT LIMITED TO ANY DEFENSE THEREOF), OR OTHER SIMILAR COSTS.
|
|
|
|
Should you have any questions regarding your right to use this Software,
|
|
contact Texas Instruments Incorporated at www.TI.com.
|
|
**************************************************************************************************/
|
|
|
|
#ifndef MAC_HIGH_LEVEL_H
|
|
#define MAC_HIGH_LEVEL_H
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
|
* Includes
|
|
* ------------------------------------------------------------------------------------------------
|
|
*/
|
|
|
|
#include "mac_api.h"
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
|
* Macros
|
|
* ------------------------------------------------------------------------------------------------
|
|
*/
|
|
#ifndef MAC_INTERNAL_API
|
|
#define MAC_INTERNAL_API
|
|
#endif
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
|
* Constants
|
|
* ------------------------------------------------------------------------------------------------
|
|
*/
|
|
|
|
/* RX flag masks */
|
|
#define MAC_RX_FLAG_VERSION 0x03 /* received frame's version */
|
|
#define MAC_RX_FLAG_ACK_PENDING 0x04 /* outgoing ACK has pending bit set */
|
|
#define MAC_RX_FLAG_SECURITY 0x08 /* received frame has security bit set */
|
|
#define MAC_RX_FLAG_PENDING 0x10 /* received frame has pending bit set */
|
|
#define MAC_RX_FLAG_ACK_REQUEST 0x20 /* received frame has ack request bit set */
|
|
#define MAC_RX_FLAG_INTRA_PAN 0x40 /* received frame has intra pan fcf bit set */
|
|
#define MAC_RX_FLAG_CRC_OK 0x80 /* received frame CRC OK bit */
|
|
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
|
* Typedefs
|
|
* ------------------------------------------------------------------------------------------------
|
|
*/
|
|
|
|
/* Structure for internal data tx */
|
|
typedef struct
|
|
{
|
|
macEventHdr_t hdr;
|
|
sData_t msdu;
|
|
macTxIntData_t internal;
|
|
macSec_t sec;
|
|
} macTx_t;
|
|
|
|
/* Structure for internal data rx */
|
|
typedef struct
|
|
{
|
|
macEventHdr_t hdr;
|
|
sData_t msdu;
|
|
macRxIntData_t internal;
|
|
macSec_t sec;
|
|
macDataInd_t mac;
|
|
sData_t mhr;
|
|
} macRx_t;
|
|
|
|
/* Function pointer for the 16 byte random seed callback */
|
|
typedef void (*macRNGFcn_t )(uint8* seed);
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
|
* Global Variables
|
|
* ------------------------------------------------------------------------------------------------
|
|
*/
|
|
|
|
/* pointer to current tx frame */
|
|
extern macTx_t *pMacDataTx;
|
|
|
|
/* TRUE if operating as a PAN coordinator */
|
|
extern bool macPanCoordinator;
|
|
|
|
/* ------------------------------------------------------------------------------------------------
|
|
* Function Prototypes
|
|
* ------------------------------------------------------------------------------------------------
|
|
*/
|
|
|
|
/* functions located in mac_data.c */
|
|
MAC_INTERNAL_API uint8 *macDataRxMemAlloc(uint16 len);
|
|
MAC_INTERNAL_API uint8 macDataRxMemFree(uint8 **pMsg);
|
|
MAC_INTERNAL_API uint8 macDataTxTimeAvailable(void);
|
|
|
|
/**************************************************************************************************
|
|
*/
|
|
|
|
#endif /* MAC_HIGH_LEVEL_H */
|