P4080 PCIe Adapter SDK User Guide Production Release

Freescale Semiconductor
/**
* API: enqueue_cmd : Enqueues a command into Command Tx ring.
* Upper-level Hardware Function Drivers on the Host use this API to send
* a command request to their counterparts on P4080.
*
* @cmd – Pointer to a Frame Descriptor that is to be enqueued into
* Command ring
*
* @return – SUCCESS (0) on successful enqueue into Command ring, otherwise
* ERROR (1)
*/
The prototype of this API is as follows
int enqueue_cmd(struct p4080_fd *cmd);
cmd – FD that needs to be enqueued into Command Tx ring.
struct p4080_fd {
u16 type;
u16 sub_type;
u32 __reserved;
u64 phys_addr_of_buff;
u64 cookie;
struct qm_fd qman_fd;
}
o type – Hardware function type
o sub_type – For denoting sub commands in a Hardware Function
o __reserved – Used for SKB headroom and tail rooms. Also used for marking
command completion status.
o phys_addr_of_buff – Physical address of SKB data
o cookie – Virtual address of the SKB
o qman_fd – Qman File Descriptor.
/**
* API: init_region_rx_shadow_offset : To avoid PCIE Reads from P4080 of Host
* Rx Descriptor rings, P4080 PCIE Framework supports use of Rx Shadow Ring
* that the Host driver writes to. This API gets the Rx Shadow ring
* address from
* the INIT region. This address belongs to P4080 PCIE address domain.
*
* @func_id – Hardware Function identifier
* @ring_id – Rx ring identifier
*
© Freescale Semiconductor, Inc., 2011. All rights reserved.
Freescale Confidential Proprietary Page 75