Defines
BMET_ETH_LLD_OSAL

Defines

#define BMET_ETH_osalMemAlloc   Osal_bmet_eth_MemAlloc
 The macro is used by the bmet Library to allocate the memory.
#define BMET_ETH_osalMemFree   Osal_bmet_eth_MemFree
 The macro is used by the bmet Library to free the memory.
#define BMET_ETH_osalEndPktAccess   Osal_bmet_eth_EndPktAccess
 The macro is used by the bmet Library to indicate that packet access has been accessed & updated . If the packet is in cached memory the implementation should writeback the contents of the packet.
#define BMET_ETH_osalBeginPktAccess   Osal_bmet_eth_BeginPktAccess
 The macro is used by the bmet Library to indicate that packet access has been accessed & updated . If the packet is in cached memory the implementation should writeback the contents of the packet.
#define BMET_ETH_osalEndMemAccess   Osal_bmet_eth_EndMemAccess
 This macro is used to alert the application that the BMET_ETH has completed access to table memory. This call will always be made following a call to Osal_BMET_ETH BeginMemAccess and have the same parameters.
#define BMET_ETH_osalException   Osal_bmet_eth_Exception
 This macro is used to alert the application that the BMET_ETH has encountered an exception.

Define Documentation

#define BMET_ETH_osalBeginPktAccess   Osal_bmet_eth_BeginPktAccess

The macro is used by the bmet Library to indicate that packet access has been accessed & updated . If the packet is in cached memory the implementation should writeback the contents of the packet.

Prototype: The following is the C prototype for the expected OSAL API.

 *       void Osal_bmet_eth_BeginMemAccess (void* addr, uint32_t sizeWords)
 *  

Parameter
addr - The address of the table to be accessed
sizeWords - The number of bytes in the table

Return Value
None

#define BMET_ETH_osalEndMemAccess   Osal_bmet_eth_EndMemAccess

This macro is used to alert the application that the BMET_ETH has completed access to table memory. This call will always be made following a call to Osal_BMET_ETH BeginMemAccess and have the same parameters.

Prototype: The following is the C prototype for the expected OSAL API.

 *      void Osal_bmet_eth_EndMemAccess (void* addr, uint32_t sizeWords)
 *  

Parameters
addr - The address of the table to be accessed
sizeWords - The number of bytes in the table

Note:
BMET_ETH will make nested calls to this function for memory access protection of different memory tables. The multicore semaphore should be freed when all previous memory access has completed, in other words, when the nested call level reaches 0.
#define BMET_ETH_osalEndPktAccess   Osal_bmet_eth_EndPktAccess

The macro is used by the bmet Library to indicate that packet access has been accessed & updated . If the packet is in cached memory the implementation should writeback the contents of the packet.

Prototype: The following is the C prototype for the expected OSAL API.

 *       void Osal_bmet_eth_EndMemAccess (void* addr, uint32_t sizeWords)
 *  

Parameter
addr - The address of the table to be accessed
sizeWords - The number of bytes in the table

Return Value
None

#define BMET_ETH_osalException   Osal_bmet_eth_Exception

This macro is used to alert the application that the BMET_ETH has encountered an exception.

Prototype: The following is the C prototype for the expected OSAL API.

 *      void Osal_bmet_eth_Exception (uint32_t moduleID, int32_t exception_num)
 *  

Parameters
addr - The address of the table to be accessed
sizeWords - The number of bytes in the table

Note:
BMET_ETH will make nested calls to this function for memory access protection of different memory tables. The multicore semaphore should be freed when all previous memory access has completed, in other words, when the nested call level reaches 0.
#define BMET_ETH_osalMemAlloc   Osal_bmet_eth_MemAlloc

The macro is used by the bmet Library to allocate the memory.

Prototype: The following is the C prototype for the expected OSAL API.

 *       void* Osal_bmet_eth_MemAlloc (uint32_t num_bytes, uint32_t alignment)
 *  

Parameter
num_bytes - number of bytes to be allocated
alignment - memory alignment

Return Value
memory address allocated

#define BMET_ETH_osalMemFree   Osal_bmet_eth_MemFree

The macro is used by the bmet Library to free the memory.

Prototype: The following is the C prototype for the expected OSAL API.

 *       void  Osal_bmet_eth_MemFree (void* ptr, uint32_t size)
 *  

Parameter
ptr - memory base address to be freed
size - size of the mem block

Return Value
None


Copyright 2014, Texas Instruments Incorporated