The SALLD Call-out function table.
More...
#include <salld.h>
Data Fields |
void(* | DebugTrace )(Sa_ChanHandle handle, uint16_t msgType, uint16_t msgCode, uint16_t msgLength, uint16_t *msgData) |
| A callout to the system code's debug and exception handling function. This is a function pointer and must point to a valid function which meets the API requirements.
|
void(* | ChanKeyRequest )(Sa_ChanHandle handle, Sa_KeyRequest_t *keyReq) |
| Callout to externally supplied system to request a new security key. This function may be triggered by either the Sa_chanSendData() or Sa_chanReceiveData() APIs. The application should call the Sa_chanControl() API to pass the new key when it is available. This is a function pointer and must point to a valid function which meets the API requirements.
|
void(* | ScAlloc )(Sa_ChanHandle handle, Sa_ScReqInfo_t *scReqInfo) |
| Callout to externally supplied system to allocate the security context with the specified size. This function must be implemented as a simple non-blocking function. This is a function pointer and must point to a valid function which meets the API requirements.
|
void(* | ScFree )(Sa_ChanHandle handle, uint16_t scID) |
| Callout to externally supplied system to release the security context with the specified ID. This function must be implemented as a simple non-blocking function. This is a function pointer and must point to a valid function which meets the API requirements.
|
void(* | ChanRegister )(Sa_ChanHandle handle, Sa_SWInfo_t *chanSwInfo) |
| Callout to externally supplied system to register the security channel with its software routing information to be programmed into the PASS lookup table in the from-Network direction. It may be triggered by the Sa_chanControl(), Sa_chanSendData() and Sa_chanReceiveData() APIs. This is a function pointer and must point to a valid function which meets the API requirements.
|
void(* | ChanUnRegister )(Sa_ChanHandle handle, Sa_SWInfo_t *chanSwInfo) |
| Callout to externally supplied system to un-register the security channel with its software routing information to be removed from the PASS lookup tables. It may be triggered by the sSa_chanClose(), Sa_chanSendData() and Sa_chanReceiveData() APIs. This is a function pointer and must point to a valid function which meets the API requirements.
|
void(* | ChanSendNullPkt )(Sa_ChanHandle handle, Sa_PktInfo_t *pktInfo) |
| Callout to externally supplied system to send an Null packet to the SA sub-system. The null packet is used to evict and/or tear down the security context associated with the channel. It may be triggered by the Sa_chanClose(), Sa_chanSendData() and Sa_chanReceiveData() APIs. This is a function pointer and must point to a valid function which meets the API requirements.
|
Detailed Description
The SALLD Call-out function table.
The SALLD software module requires a set of call-out functions to report debug information, request and free system resources, and etc. All the call-out functions should be implemented by the application and provided to the SALLD at Sa_create
Definition at line 1899 of file salld.h.
Field Documentation
Callout to externally supplied system to request a new security key. This function may be triggered by either the Sa_chanSendData() or Sa_chanReceiveData() APIs. The application should call the Sa_chanControl() API to pass the new key when it is available. This is a function pointer and must point to a valid function which meets the API requirements.
- Parameters:
-
[in] | handle | SALLD channel instance identifier. |
[in] | keyReq | Pointer to SALLD key Request structure. |
- See also:
- Sa_KeyRequest_t
Definition at line 1925 of file salld.h.
Callout to externally supplied system to register the security channel with its software routing information to be programmed into the PASS lookup table in the from-Network direction. It may be triggered by the Sa_chanControl(), Sa_chanSendData() and Sa_chanReceiveData() APIs. This is a function pointer and must point to a valid function which meets the API requirements.
- Parameters:
-
[in] | handle | SALLD channel instance identifier. |
[in] | chanSwInfo | Pointer to SALLD software routing information structure. |
- See also:
- Sa_SWInfo_t
Definition at line 1967 of file salld.h.
Callout to externally supplied system to send an Null packet to the SA sub-system. The null packet is used to evict and/or tear down the security context associated with the channel. It may be triggered by the Sa_chanClose(), Sa_chanSendData() and Sa_chanReceiveData() APIs. This is a function pointer and must point to a valid function which meets the API requirements.
- Parameters:
-
[in] | handle | SALLD channel instance identifier. |
[in] | pktInfo | Pointer to the packet info structure. |
- See also:
- Sa_PktInfo_t
Definition at line 1995 of file salld.h.
Callout to externally supplied system to un-register the security channel with its software routing information to be removed from the PASS lookup tables. It may be triggered by the sSa_chanClose(), Sa_chanSendData() and Sa_chanReceiveData() APIs. This is a function pointer and must point to a valid function which meets the API requirements.
- Parameters:
-
[in] | handle | SALLD channel instance identifier. |
[in] | chanSwInfo | Pointer to SALLD software routing information structure. |
- See also:
- Sa_SWInfo_t
Definition at line 1981 of file salld.h.
A callout to the system code's debug and exception handling function. This is a function pointer and must point to a valid function which meets the API requirements.
- Parameters:
-
[in] | handle | SALLD channel instance identifier. |
[in] | msgType | Specify how serious the debug message is as defined at SALLD Debug message types. |
[in] | msgCode | Specify the message code as defined at SALLD Debug message codes. |
[in] | msgLength | Specify the length of the message supporting data. |
[in] | msgData | Pointer to the message supporting data. |
Definition at line 1911 of file salld.h.
Callout to externally supplied system to allocate the security context with the specified size. This function must be implemented as a simple non-blocking function. This is a function pointer and must point to a valid function which meets the API requirements.
- Parameters:
-
[in] | handle | SALLD channel instance identifier. |
[in] | scReqInfo | Pointer to SALLD security context Request Information structure. |
- See also:
- Sa_ScReqInfo_t
Definition at line 1938 of file salld.h.
Callout to externally supplied system to release the security context with the specified ID. This function must be implemented as a simple non-blocking function. This is a function pointer and must point to a valid function which meets the API requirements.
- Parameters:
-
[in] | handle | SALLD channel instance identifier. |
[in] | scID | Security Context ID |
- Note:
- The security context buffer is only released from the SA LLD and is still owned by SA. It should be maintained at the Pending Free list until it is freed by SA. Use API Sa_isScBufFree() to check its status.
Definition at line 1953 of file salld.h.
The documentation for this struct was generated from the following file: