Data Plane Development Kit Reference Manual: Intel FPGA Programmable Acceleration Card N3000

Download PDF
ID 683512
Date 12/06/2019
Public
Document Table of Contents
Document Table of Contents x
1. About this Document 2. Data Plane Development Kit Overview 3. IFPGA Base Code Design 4. Ethernet Group and Retimer API 5. Revision History for the Data Plane Development Kit Reference Manual: Intel® FPGA PAC N3000
1. About this Document x
1.1. About this Document 1.2. Acronym List
2. Data Plane Development Kit Overview x
2.1. DPDK Intel® FPGA PAC N3000 Software Overview 2.2. DPDK Intel® FPGA PAC N3000 Software Components 2.3. FPGA Scan and Enumeration 2.4. OPAE User Mode Driver 2.5. OPAE User Mode Driver API Summary
2.4. OPAE User Mode Driver x
2.4.1. OPAE FPGA Adapter 2.4.2. OPAE Manager OPAE Data Structures 2.4.3. OPAE Accelerator 2.4.4. OPAE Bridge
2.4.1. OPAE FPGA Adapter x
2.4.1.1. opae_adapter_init() 2.4.1.2. opae_adapter_data_alloc() 2.4.1.3. opae_adapter_enumerate() 2.4.1.4. opae_adapter_destroy()
2.4.2. OPAE Manager x
OPAE Data Structures 2.4.2.1. opae_manager_alloc() 2.4.2.2. opae_manager_flash() 2.4.2.3. opae_manager_get_eth_group_region_info() 2.4.2.4. Sensor Information 2.4.2.5. opae_mgr_get_sensor_value_by_name() 2.4.2.6. opae_mgr_get_sensor_value_by_id() 2.4.2.7. opae_mgr_get_sensor_value() 2.4.2.8. opae_manager_networking_ops
2.4.3. OPAE Accelerator x
2.4.3.1. opae_accelerator_alloc() 2.4.3.2. opae_acc_get_uuid() 2.4.3.3. opae_acc_get_region_info() 2.4.3.4. opae_acc_get_info()
2.4.4. OPAE Bridge x
2.4.4.1. opae_bridge_alloc() 2.4.4.2. opae_bridge_reset()
2.5. OPAE User Mode Driver API Summary x
2.5.1. Example Code
3. IFPGA Base Code Design x
3.1. FPGA Management 3.2. Accelerator Access and Control
4. Ethernet Group and Retimer API x
4.1. opae_manager_get_eth_group_nums() 4.2. opae_manager_get_eth_group_info() 4.3. opae_manager_eth_group_write_reg() 4.4. opae_manager_eth_group_read_reg() 4.5. opae_manager_get_eth_group_region_info() 4.6. Data Structures for Retiming 4.7. opae_manager_get_retimer_info() 4.8. opae_manager_get_retimer_status()
1. About this Document
2. Data Plane Development Kit Overview
3. IFPGA Base Code Design
4. Ethernet Group and Retimer API
5. Revision History for the Data Plane Development Kit Reference Manual: Intel® FPGA PAC N3000

2.4.2. OPAE Manager

OPAE Data Structures

The $RTE_SDK/drivers/raw/ifpga_rawdev/base/opae_hw_api.h header file defines the following data structures. 

struct opae_manager {
   const char *name;
   struct opae_adapter *adapter;
   struct opae_manager_ops *ops;
   struct opae_manager_networking_ops *network_ops;
   void *data;
Table 3.  opae_manager Struct Field Definitions
Data Structure Field Names Description
name A pointer to the name of the opae_manager.
adapter A pointer to the opae_adapter data structure.
ops A pointer to the opae_manager_ops data structure which defines the operations that the OPAE manager provides:
struct opae_manager_ops {
        int (*flash)(struct opae_manager *mgr, int id, 
		const char *buffer, u32 size, u64 *status);
        int (*get_eth_group_region_info)
			(struct opae_manager *mgr,
                struct opae_eth_group_region_info *info);
        int (*get_sensor_value)(struct opae_manager *mgr,
                struct opae_sensor_info *sensor,
                unsigned int *value);
        int (*get_board_info)(struct opae_manager *mgr,
                truct opae_board_info **info);
};
opae_manager_networking_ops A pointer to the opae_manager_networking_ops data structure which defines the networking functions required for networking on the Intel® FPGA PAC N3000: 
struct opae_manager_networking_ops {
        int (*read_mac_rom)(struct opae_manager *mgr, int offset, 
					void *buf,int size);
        int (*write_mac_rom)(struct opae_manager *mgr, int offset, 
					void *buf, int size);
        int (*get_eth_group_nums)(struct opae_manager *mgr);
        int (*get_eth_group_info)(struct opae_manager *mgr,
                        u8 group_id, struct opae_eth_group_info *info);
        int (*eth_group_reg_read)(struct opae_manager *mgr, u8 group_id,
                        u8 type, u8 index, u16 addr, u32 *data);
        int (*eth_group_reg_write)(struct opae_manager *mgr, u8 group_id,
                        u8 type, u8 index, u16 addr, u32 data);
        int (*get_retimer_info)(struct opae_manager *mgr,
                        struct opae_retimer_info *info);
        int (*get_retimer_status)(struct opae_manager *mgr,
                        struct opae_retimer_status *status);
};
data A pointer to opae_manager private data.

The OPAE manager exports the following API functions:

Level Two Title