third_party/nxp/JN5189DK6/middleware/wireless/ieee-802.15.4/uMac/Include/MMAC.h - third_party/openthread - Git at Google

 /*
 * Copyright (c) 2014 - 2015, Freescale Semiconductor, Inc.
 * Copyright 2016-2019 NXP
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

 #ifndef MICRO_MAC_H
 #define MICRO_MAC_H

 #if defined __cplusplus
 extern "C" {
 #endif


 /****************************************************************************/
 /***        Include Files                                                 ***/
 /****************************************************************************/
 #include "jendefs.h"

 /****************************************************************************/
 /***        Macro/Type Definitions                                        ***/
 /****************************************************************************/

 typedef struct
 {
     uint32 u32L;  /**< Low word */
     uint32 u32H;  /**< High word */
 } tsExtAddr;

 typedef union
 {
     uint16    u16Short;
     tsExtAddr sExt;
 } tuAddr;

 /* Structure for building a MAC frame, where the MAC header alignment is
    handled by the hardware */
 typedef struct
 {
     uint8           u8PayloadLength;
     uint8           u8SequenceNum;
     uint16          u16FCF;
     uint16          u16DestPAN;
     uint16          u16SrcPAN;
     tuAddr          uDestAddr;
     tuAddr          uSrcAddr;
     uint16          u16FCS;
     uint16          u16Unused;
     union
     {
         uint8     au8Byte[127]; /* Payload as both bytes and words */
         uint32    au32Word[32];
     } uPayload;
 } tsMacFrame;

 /* Structure for building a PHY frame, where the MAC header format is
    undefined */
 typedef struct
 {
     uint8           u8PayloadLength;
     uint8           au8Padding[3];
     union
     {
         uint8     au8Byte[127]; /* Payload as both bytes and words */
         uint32    au32Word[32];
     } uPayload;
 } tsPhyFrame;

 typedef struct
 {
     uint8  u8SecurityLevel;
     uint8  u8KeyIdMode;
     uint8  u8KeyIndex;
     bool_t bPassedSecurity;
 } tsSecurity;

 typedef struct
 {
     tsMacFrame     sFrameBody;
     tsSecurity     sSecurityData;
     uint32         u32Timestamp;
     uint8          u8LinkQuality;
     uint8          u8Msq;
 } tsRxFrameFormat;

 /* Options for reception, to pass to vMMAC_StartReceive. User should select
    one from each pair of options, and logical OR the options together */
 typedef enum
 {
     /* Receive start time: now or delayed */
     E_MMAC_RX_START_NOW        = 0x0002,
     E_MMAC_RX_DELAY_START      = 0x0003,

     /* Timing alignment for auto ack transmission: normal or aligned to
        backoff clock (used in CAP period in beacon networks) */
     E_MMAC_RX_ALIGN_NORMAL     = 0x0000,
     E_MMAC_RX_ALIGNED          = 0x0004,

     /* Wait for auto ack and retry: don't use or use */
     E_MMAC_RX_NO_AUTO_ACK      = 0x0000,
     E_MMAC_RX_USE_AUTO_ACK     = 0x0008,

     /* Malformed packets: reject or accept */
     E_MMAC_RX_NO_MALFORMED     = 0x0000,
     E_MMAC_RX_ALLOW_MALFORMED  = 0x0400,

     /* Frame Check Sequence errors: reject or accept */
     E_MMAC_RX_NO_FCS_ERROR     = 0x0000,
     E_MMAC_RX_ALLOW_FCS_ERROR  = 0x0200,

     /* Address matching: enable or disable */
     E_MMAC_RX_NO_ADDRESS_MATCH = 0x0000,
     E_MMAC_RX_ADDRESS_MATCH    = 0x0100

 } teRxOption;

 /* Options for transmission, to pass to vMMAC_StartMacTransmit or
    vMMAC_StartPhyTransmit. User should select one from each set of options,
    and logical OR the options together */
 typedef enum
 {
     /* Transmit start time: now or delayed */
     E_MMAC_TX_START_NOW       = 0x02,
     E_MMAC_TX_DELAY_START     = 0x03,

     /* Wait for auto ack and retry: don't use or use */
     E_MMAC_TX_NO_AUTO_ACK     = 0x00,
     E_MMAC_TX_USE_AUTO_ACK    = 0x08,

     /* Clear channel assessment: don't use or use, plus option to align to
        backoff clock */
     E_MMAC_TX_NO_CCA          = 0x00,
     E_MMAC_TX_USE_CCA         = 0x10,
     E_MMAC_TX_USE_CCA_ALIGNED = 0x20

 } teTxOption;

 /* Flags for receive status, as returned by u32MMAC_GetRxErrors */
 typedef enum
 {
     E_MMAC_RXSTAT_ERROR     = 0x01, /* Frame check sequence error */
     E_MMAC_RXSTAT_ABORTED   = 0x02, /* Reception aborted by user */
     E_MMAC_RXSTAT_MALFORMED = 0x20  /* Frame was malformed */
 } teRxStatus;

 /* Flags for transmit status, as returned by u32MMAC_GetTxErrors */
 typedef enum
 {
     E_MMAC_TXSTAT_CCA_BUSY = 0x01, /* Channel wasn't free */
     E_MMAC_TXSTAT_NO_ACK   = 0x02, /* Ack requested but not seen */
     E_MMAC_TXSTAT_ABORTED  = 0x04, /* Transmission aborted by user */
     E_MMAC_TXSTAT_TXTO     = 0x20, /* Radio transmission timeout */
     E_MMAC_TXSTAT_TXPCTO   = 0x40  /* Modem transmission timeout */
 } teTxStatus;

 /* Flags for interrupt status, as returned to handler registered with
    vMMAC_EnableInterrupts and as used in the mask passed to
    vMMAC_ConfigureInterruptSources, u32MMAC_PollInterruptSource,
    u32MMAC_PollInterruptSourceUntilFired */
 typedef enum
 {
     E_MMAC_INT_TX_COMPLETE  = 0x01, /* Transmission attempt has finished */
     E_MMAC_INT_RX_HEADER    = 0x02, /* MAC header has been received */
     E_MMAC_INT_RX_COMPLETE  = 0x04  /* Complete frame has been received */
 } teIntStatus;

 /* CCA mode to use when transmitting. Use with vMMAC_SetCcaMode(). Default is
    E_MMAC_CCAMODE_ENERGY */
 typedef enum
 {
     E_MMAC_CCAMODE_ENERGY            = 0x01, /* Energy above threshold */
     E_MMAC_CCAMODE_CARRIER           = 0x02, /* Carrier sense */
     E_MMAC_CCAMODE_ENERGY_OR_CARRIER = 0x03  /* Either energy or carrier */
 } teCcaMode;

 /****************************************************************************/
 /***        Exported Functions                                            ***/
 /****************************************************************************/
 /* Initialisation */
 PUBLIC void vMMAC_Enable(void);
 PUBLIC void vMMAC_Disable(void);
 PUBLIC void vMMAC_ConfigureRadio(void);
 PUBLIC void vMMAC_SetChannel(uint8 u8Channel);
 PUBLIC void vMMAC_SetChannelAndPower(uint8 u8Channel, int i8TxPower);
 PUBLIC int8 i8MMAC_GetTxPowerLevel(void);

 /* Interrupt control */
 PUBLIC void vMMAC_EnableInterrupts(void (*prHandler)(uint32 u32Mask));
 PUBLIC void vMMAC_RegisterPhyIntHandler(void (*prHandler)(uint32 u32Mask));
 PUBLIC void vMMAC_ConfigureInterruptSources(uint32 u32Mask);
 PUBLIC uint32 u32MMAC_PollInterruptSource(uint32 u32Mask);
 PUBLIC uint32 u32MMAC_PollInterruptSourceUntilFired(uint32 u32Mask);

 /* Miscellaneous */
 PUBLIC uint32 u32MMAC_GetTime(void);
 PUBLIC void vMMAC_RadioOff(void);
 PUBLIC void vMMAC_RadioToOffAndWait(void);
 PUBLIC void vMMAC_SetCutOffTimer(uint32 u32CutOffTime, bool_t bEnable);
 PUBLIC void vMMAC_SynchroniseBackoffClock(bool_t bEnable);
 PUBLIC void vMMAC_GetMacAddress(tsExtAddr *psMacAddr);
 PUBLIC uint8 u8MMAC_EnergyDetect(uint32 u32DurationSymbols);
 PUBLIC uint32 u32MMAC_GetPhyState(void);
 PUBLIC void vMMAC_RxCtlUpdate(uint32 u32NewValue);
 PUBLIC void vMMAC_AbortRadio(void);
 PUBLIC void vMMAC_SetHighPowerOptions(void);
 PUBLIC void vMMAC_PromiscuousMode(bool_t bPromiscuous);
 PUBLIC void vMMAC_WriteCcaThreshold(uint8 u8CcaThreshold);
 PUBLIC uint8 u8MMAC_ReadCcaThreshold(void);

 /* Receive */
 PUBLIC void vMMAC_SetRxAddress(uint32 u32PanId, uint16 u16Short,
                                tsExtAddr *psMacAddr);
 PUBLIC void vMMAC_SetRxPanId(uint32 u32PanId);
 PUBLIC void vMMAC_SetRxShortAddr(uint16 u16Short);
 PUBLIC void vMMAC_SetRxExtendedAddr(tsExtAddr *psMacAddr);
 PUBLIC void vMMAC_SetRxStartTime(uint32 u32Time);
 PUBLIC void vMMAC_StartMacReceive(tsMacFrame *psFrame, teRxOption eOptions);
 PUBLIC void vMMAC_StartPhyReceive(tsPhyFrame *psFrame, teRxOption eOptions);
 PUBLIC void vMMAC_SetRxFrame(tsRxFrameFormat *pRxFrame);
 PUBLIC void vMMAC_SetRxProm(uint32_t u32Prom);
 PUBLIC bool_t bMMAC_RxDetected(void);
 PUBLIC uint32 u32MMAC_GetRxErrors(void);
 PUBLIC uint32 u32MMAC_GetRxTime(void);
 PUBLIC uint8 u8MMAC_GetRxLqi(uint8 *pu8Msq);

 /* Transmit */
 PUBLIC void vMMAC_SetTxParameters(uint8 u8Attempts, uint8 u8MinBE,
                                   uint8 u8MaxBE, uint8 u8MaxBackoffs);
 PUBLIC void vMMAC_SetTxStartTime(uint32 u32Time);
 PUBLIC void vMMAC_SetCcaMode(teCcaMode eCcaMode);
 PUBLIC void vMMAC_StartMacTransmit(tsMacFrame *psFrame, teTxOption eOptions);
 PUBLIC void vMMAC_StartPhyTransmit(tsPhyFrame *psFrame, teTxOption eOptions);
 PUBLIC void vMMAC_SetTxPend(bool_t bTxPend);
 PUBLIC uint32 u32MMAC_GetTxErrors(void);
 PUBLIC bool_t bMMAC_PowerStatus(void);

 /****************************************************************************/
 /***        Exported Variables                                            ***/
 /****************************************************************************/

 #if defined __cplusplus
 }
 #endif

 #endif /* #ifndef MICRO_MAC_H */

 /****************************************************************************/
 /***        END OF FILE                                                   ***/
 /****************************************************************************/
	/*
	* Copyright (c) 2014 - 2015, Freescale Semiconductor, Inc.
	* Copyright 2016-2019 NXP
	* All rights reserved.
	*
	* SPDX-License-Identifier: BSD-3-Clause
	*/

	#ifndef MICRO_MAC_H
	#define MICRO_MAC_H

	#if defined __cplusplus
	extern "C" {
	#endif


	/****************************************************************************/
	/* Include Files */
	/****************************************************************************/
	#include "jendefs.h"

	/****************************************************************************/
	/* Macro/Type Definitions */
	/****************************************************************************/

	typedef struct
	{
	uint32 u32L; /*< Low word /
	uint32 u32H; /*< High word /
	} tsExtAddr;

	typedef union
	{
	uint16 u16Short;
	tsExtAddr sExt;
	} tuAddr;

	/* Structure for building a MAC frame, where the MAC header alignment is
	handled by the hardware */
	typedef struct
	{
	uint8 u8PayloadLength;
	uint8 u8SequenceNum;
	uint16 u16FCF;
	uint16 u16DestPAN;
	uint16 u16SrcPAN;
	tuAddr uDestAddr;
	tuAddr uSrcAddr;
	uint16 u16FCS;
	uint16 u16Unused;
	union
	{
	uint8 au8Byte[127]; /* Payload as both bytes and words */
	uint32 au32Word[32];
	} uPayload;
	} tsMacFrame;

	/* Structure for building a PHY frame, where the MAC header format is
	undefined */
	typedef struct
	{
	uint8 u8PayloadLength;
	uint8 au8Padding[3];
	union
	{
	uint8 au8Byte[127]; /* Payload as both bytes and words */
	uint32 au32Word[32];
	} uPayload;
	} tsPhyFrame;

	typedef struct
	{
	uint8 u8SecurityLevel;
	uint8 u8KeyIdMode;
	uint8 u8KeyIndex;
	bool_t bPassedSecurity;
	} tsSecurity;

	typedef struct
	{
	tsMacFrame sFrameBody;
	tsSecurity sSecurityData;
	uint32 u32Timestamp;
	uint8 u8LinkQuality;
	uint8 u8Msq;
	} tsRxFrameFormat;

	/* Options for reception, to pass to vMMAC_StartReceive. User should select
	one from each pair of options, and logical OR the options together */
	typedef enum
	{
	/* Receive start time: now or delayed */
	E_MMAC_RX_START_NOW = 0x0002,
	E_MMAC_RX_DELAY_START = 0x0003,

	/* Timing alignment for auto ack transmission: normal or aligned to
	backoff clock (used in CAP period in beacon networks) */
	E_MMAC_RX_ALIGN_NORMAL = 0x0000,
	E_MMAC_RX_ALIGNED = 0x0004,

	/* Wait for auto ack and retry: don't use or use */
	E_MMAC_RX_NO_AUTO_ACK = 0x0000,
	E_MMAC_RX_USE_AUTO_ACK = 0x0008,

	/* Malformed packets: reject or accept */
	E_MMAC_RX_NO_MALFORMED = 0x0000,
	E_MMAC_RX_ALLOW_MALFORMED = 0x0400,

	/* Frame Check Sequence errors: reject or accept */
	E_MMAC_RX_NO_FCS_ERROR = 0x0000,
	E_MMAC_RX_ALLOW_FCS_ERROR = 0x0200,

	/* Address matching: enable or disable */
	E_MMAC_RX_NO_ADDRESS_MATCH = 0x0000,
	E_MMAC_RX_ADDRESS_MATCH = 0x0100

	} teRxOption;

	/* Options for transmission, to pass to vMMAC_StartMacTransmit or
	vMMAC_StartPhyTransmit. User should select one from each set of options,
	and logical OR the options together */
	typedef enum
	{
	/* Transmit start time: now or delayed */
	E_MMAC_TX_START_NOW = 0x02,
	E_MMAC_TX_DELAY_START = 0x03,

	/* Wait for auto ack and retry: don't use or use */
	E_MMAC_TX_NO_AUTO_ACK = 0x00,
	E_MMAC_TX_USE_AUTO_ACK = 0x08,

	/* Clear channel assessment: don't use or use, plus option to align to
	backoff clock */
	E_MMAC_TX_NO_CCA = 0x00,
	E_MMAC_TX_USE_CCA = 0x10,
	E_MMAC_TX_USE_CCA_ALIGNED = 0x20

	} teTxOption;

	/* Flags for receive status, as returned by u32MMAC_GetRxErrors */
	typedef enum
	{
	E_MMAC_RXSTAT_ERROR = 0x01, /* Frame check sequence error */
	E_MMAC_RXSTAT_ABORTED = 0x02, /* Reception aborted by user */
	E_MMAC_RXSTAT_MALFORMED = 0x20 /* Frame was malformed */
	} teRxStatus;

	/* Flags for transmit status, as returned by u32MMAC_GetTxErrors */
	typedef enum
	{
	E_MMAC_TXSTAT_CCA_BUSY = 0x01, /* Channel wasn't free */
	E_MMAC_TXSTAT_NO_ACK = 0x02, /* Ack requested but not seen */
	E_MMAC_TXSTAT_ABORTED = 0x04, /* Transmission aborted by user */
	E_MMAC_TXSTAT_TXTO = 0x20, /* Radio transmission timeout */
	E_MMAC_TXSTAT_TXPCTO = 0x40 /* Modem transmission timeout */
	} teTxStatus;

	/* Flags for interrupt status, as returned to handler registered with
	vMMAC_EnableInterrupts and as used in the mask passed to
	vMMAC_ConfigureInterruptSources, u32MMAC_PollInterruptSource,
	u32MMAC_PollInterruptSourceUntilFired */
	typedef enum
	{
	E_MMAC_INT_TX_COMPLETE = 0x01, /* Transmission attempt has finished */
	E_MMAC_INT_RX_HEADER = 0x02, /* MAC header has been received */
	E_MMAC_INT_RX_COMPLETE = 0x04 /* Complete frame has been received */
	} teIntStatus;

	/* CCA mode to use when transmitting. Use with vMMAC_SetCcaMode(). Default is
	E_MMAC_CCAMODE_ENERGY */
	typedef enum
	{
	E_MMAC_CCAMODE_ENERGY = 0x01, /* Energy above threshold */
	E_MMAC_CCAMODE_CARRIER = 0x02, /* Carrier sense */
	E_MMAC_CCAMODE_ENERGY_OR_CARRIER = 0x03 /* Either energy or carrier */
	} teCcaMode;

	/****************************************************************************/
	/* Exported Functions */
	/****************************************************************************/
	/* Initialisation */
	PUBLIC void vMMAC_Enable(void);
	PUBLIC void vMMAC_Disable(void);
	PUBLIC void vMMAC_ConfigureRadio(void);
	PUBLIC void vMMAC_SetChannel(uint8 u8Channel);
	PUBLIC void vMMAC_SetChannelAndPower(uint8 u8Channel, int i8TxPower);
	PUBLIC int8 i8MMAC_GetTxPowerLevel(void);

	/* Interrupt control */
	PUBLIC void vMMAC_EnableInterrupts(void (*prHandler)(uint32 u32Mask));
	PUBLIC void vMMAC_RegisterPhyIntHandler(void (*prHandler)(uint32 u32Mask));
	PUBLIC void vMMAC_ConfigureInterruptSources(uint32 u32Mask);
	PUBLIC uint32 u32MMAC_PollInterruptSource(uint32 u32Mask);
	PUBLIC uint32 u32MMAC_PollInterruptSourceUntilFired(uint32 u32Mask);

	/* Miscellaneous */
	PUBLIC uint32 u32MMAC_GetTime(void);
	PUBLIC void vMMAC_RadioOff(void);
	PUBLIC void vMMAC_RadioToOffAndWait(void);
	PUBLIC void vMMAC_SetCutOffTimer(uint32 u32CutOffTime, bool_t bEnable);
	PUBLIC void vMMAC_SynchroniseBackoffClock(bool_t bEnable);
	PUBLIC void vMMAC_GetMacAddress(tsExtAddr *psMacAddr);
	PUBLIC uint8 u8MMAC_EnergyDetect(uint32 u32DurationSymbols);
	PUBLIC uint32 u32MMAC_GetPhyState(void);
	PUBLIC void vMMAC_RxCtlUpdate(uint32 u32NewValue);
	PUBLIC void vMMAC_AbortRadio(void);
	PUBLIC void vMMAC_SetHighPowerOptions(void);
	PUBLIC void vMMAC_PromiscuousMode(bool_t bPromiscuous);
	PUBLIC void vMMAC_WriteCcaThreshold(uint8 u8CcaThreshold);
	PUBLIC uint8 u8MMAC_ReadCcaThreshold(void);

	/* Receive */
	PUBLIC void vMMAC_SetRxAddress(uint32 u32PanId, uint16 u16Short,
	tsExtAddr *psMacAddr);
	PUBLIC void vMMAC_SetRxPanId(uint32 u32PanId);
	PUBLIC void vMMAC_SetRxShortAddr(uint16 u16Short);
	PUBLIC void vMMAC_SetRxExtendedAddr(tsExtAddr *psMacAddr);
	PUBLIC void vMMAC_SetRxStartTime(uint32 u32Time);
	PUBLIC void vMMAC_StartMacReceive(tsMacFrame *psFrame, teRxOption eOptions);
	PUBLIC void vMMAC_StartPhyReceive(tsPhyFrame *psFrame, teRxOption eOptions);
	PUBLIC void vMMAC_SetRxFrame(tsRxFrameFormat *pRxFrame);
	PUBLIC void vMMAC_SetRxProm(uint32_t u32Prom);
	PUBLIC bool_t bMMAC_RxDetected(void);
	PUBLIC uint32 u32MMAC_GetRxErrors(void);
	PUBLIC uint32 u32MMAC_GetRxTime(void);
	PUBLIC uint8 u8MMAC_GetRxLqi(uint8 *pu8Msq);

	/* Transmit */
	PUBLIC void vMMAC_SetTxParameters(uint8 u8Attempts, uint8 u8MinBE,
	uint8 u8MaxBE, uint8 u8MaxBackoffs);
	PUBLIC void vMMAC_SetTxStartTime(uint32 u32Time);
	PUBLIC void vMMAC_SetCcaMode(teCcaMode eCcaMode);
	PUBLIC void vMMAC_StartMacTransmit(tsMacFrame *psFrame, teTxOption eOptions);
	PUBLIC void vMMAC_StartPhyTransmit(tsPhyFrame *psFrame, teTxOption eOptions);
	PUBLIC void vMMAC_SetTxPend(bool_t bTxPend);
	PUBLIC uint32 u32MMAC_GetTxErrors(void);
	PUBLIC bool_t bMMAC_PowerStatus(void);

	/****************************************************************************/
	/* Exported Variables */
	/****************************************************************************/

	#if defined __cplusplus
	}
	#endif

	#endif /* #ifndef MICRO_MAC_H */

	/****************************************************************************/
	/* END OF FILE */
	/****************************************************************************/