P4080 PCIe Adapter SDK User Guide Production Release

Freescale Semiconductor
* PCD Frame Queue callback functions when there is a Rx packet from the
* interface These QMAN invoked callback functions are registered with QMan
* Driver by the Hardware Function library.
* This API initiates the DMA of data from P4080 to Host memory.
* The completion of the Rx DMA is detected via the DMA poll API
* dma_channel_poll() which then sends an MSI interrupt.
* @qman_fd – FD received from QMan Driver.
* @hw_fn_id – Identifier of Hardware Function. The value is chosen from
* “enum hw_fns”
* @ring_id – Identifier of Rx ring on Host. The range of values is
* “[0, Number of Rx rings - 1]”
*/
The Prototype of this API is as follows.
int pkt_drv_enqueue_host_ring(const struct qm_fd *qman_fd, int hw_fn_id, int ring_id);
/**
* API: pkt_drv_process_command_ring : Dequeues commands from command
* Tx ring * and calls the command ring callback of corresponding Hardware
Function.
* The Hardware Function callback is registered with to the USDPAA PCIe Driver
* at the time of registration. This callback implements necessary action
* that is specific to a Hardware Function.
*/
void pkt_drv_process_command_ring(void);
/**
* API: pkt_drv_enqueue_cmd_response : This API enqueues
* command response into * Command ring.
* The “type” and “sub_type” fields of “struct p4080_fd”
* are modified to match the response to a request.
* Every hardware function driver is mandated to invoke this API immediately
* in the context of the cmd_poll_cb to ensure in-order delivery of command
* responses to the host. It should be noted that invocation of this API does
* not signal completion of command processing. It is simply a mechanism to
* enqueue responses in order. Upon completion of a command request, the
* hardware function driver should invoke pkt_drv_confirm_cmd_response().
*
* @cmd_fd – Command request FD that is used to form the command response
*
* @return – Returns pointer to the response FD that is enqueued into
* Rx command ring on Host. This needs to be passed as an argument
* in the pkt_drv_confirm_cmd_response()
to mark the FD as
* “completed request”. This eliminates out-of-order processing of
* command request.
*/
The prototype of this API is as follows.
struct p4080_fd *pkt_drv_enqueue_cmd_response(struct p4080_fd *cmd_fd);
© Freescale Semiconductor, Inc., 2011. All rights reserved.
Freescale Confidential Proprietary Page 58