P4080 PCIe Adapter SDK User Guide Production Release

Freescale Semiconductor
10.2 Host PCIE Packet Driver APIs
Initialization and Cleanup
/**
* API: register_hardware_function : Each Upper-level Hardware Function Driver
* (10G Ethernet, PME, Security) on Host invokes
* this API to register itself with the Host Packet Driver.
*
* @func_id – Identifier of a Hardware Function.
* @init_data – Pointer to struct hw_eng_data data structure that is exchanged
* between Hardware Function Driver and Host Packet Driver for initialization.
*
* @return – SUCCESS (0) on successful registration, ERROR (1) on failure.
*/
The prototype of this API is as follows.
int register_hardware_function(P4080_HW_FUNCTIONS func_id, struct hw_eng_data
*init_data);
func_id – This is the identifier for a Hardware Function that is to be registered with the
Host Packet Driver. Its values are taken from “enum P4080_HW_FUNCTIONS”.
typedef enum P4080_HW_FUNCTIONS {
P4080_HW_MIN = 0,
P4080_HW_ETH0,
P4080_HW_ETH1,
P4080_HW_SEC,
P4080_HW_PME,
P4080_HW_MAX
} P4080_HW_FUNCTIONS;
init_data – The initialization data structure that contains various input and output
parameters used by Host Packet Driver during registration.
typedef struct hw_eng_data {
© Freescale Semiconductor, Inc., 2011. All rights reserved.
Freescale Confidential Proprietary Page 66