P4080 PCIe Adapter SDK User Guide Production Release

Freescale Semiconductor
10 C-API
10.1 P4080 USDPAA PCIe Packet Driver API
Initialization and Cleanup
/**
* API: pkt_drv_register_hw_function : Each Hardware Function
* (10G Ethernet/Security Engine/PME) has to register
* with PCIe Driver using this API. This API has to be invoked in the
* context of Hardware Function initialization function
* (such as hw_fn_init_eth()).
* This API copies the Hardware function's Tx callback function and command
* callback function into PCIe Driver context. The Tx callback function is
* invoked by the PCIe Driver when it receives a Tx packet from Host. The
* Command callback function is invoked when there is a command to the Hardware
* Function from Host.
*
* @hw_fns - Hardware Function identifier
* @hw_data - Pointer to Tx and command callback function pointers
*
* @return - SUCCESS (0) on successful registration otherwise ERROR (1)
*/
The prototype of the registration API is as follows.
int pkt_drv_register_hw_function(enum hw_fn hw_fns, struct hw_fn_data *hw_data);
hw_fns – Identifier for a hardware function
enum hw_fns {
}
HW_FUNC_CMD,
HW_FUNC_ETH0,
HW_FUNC_ETH1,
HW_FUNC_SEC,
HW_FUNC_PME
© Freescale Semiconductor, Inc., 2011. All rights reserved.
Freescale Confidential Proprietary Page 54