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 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
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
OPAE Adapter API OPAE Manager API OPAE Accelerator API Register Read and Write Accelerator API OPAE Bridge 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.5. OPAE User Mode Driver API Summary

Here is a summary of the OPAE User Mode Driver. The drivers/raw/ifpga/base/opae_hw_api.h header file defines this API.

OPAE Adapter API 

opae_adapter_free(adapter)

int opae_adapter_enumerate(struct opae_adapter *adapter);

void opae_adapter_destroy(struct opae_adapter *adapter);


void *opae_adapter_data_alloc(enum opae_adapter_type type);

OPAE Manager API 

struct opae_manager *opae_manager_alloc(const char *name, 
			struct opae_manager_ops *ops,
			struct opae_manager_networking_ops *network_ops, void *data);

opae_manager_free(mgr) 
int opae_manager_get_eth_group_region_info(struct opae_manager *mgr,
                u8 group_id, struct opae_eth_group_region_info *info);

struct opae_sensor_info *opae_mgr_get_sensor_by_name(struct opae_manager *mgr,
                const char *name);

struct opae_sensor_info *opae_mgr_get_sensor_by_id(struct opae_manager *mgr,
                unsigned int id);

int opae_mgr_get_sensor_value_by_name(struct opae_manager *mgr,
                const char *name, unsigned int *value);

int opae_mgr_get_sensor_value_by_id(struct opae_manager *mgr,
                unsigned int id, unsigned int *value);

int opae_mgr_get_sensor_value(struct opae_manager *mgr,
                struct opae_sensor_info *sensor,
                unsigned int *value);

OPAE Accelerator API 

struct opae_accelerator *
opae_accelerator_alloc(const char *name, struct opae_accelerator_ops *ops,
		       void *data);

opae_accelerator_free(acc)
int opae_acc_get_info(struct opae_accelerator *acc, struct opae_acc_info *info);
int opae_acc_get_region_info(struct opae_accelerator *acc,
			     struct opae_acc_region_info *info);

int opae_acc_get_uuid(struct opae_accelerator *acc,
		      struct uuid *uuid);

Register Read and Write Accelerator API 

opae_acc_reg_read64(acc, region, offset, data) 
opae_acc_reg_write64(acc, region, offset, data) 
opae_acc_reg_read32(acc, region, offset, data)
opae_acc_reg_write32(acc, region, offset, data) 
opae_acc_reg_read16(acc, region, offset, data) 
opae_acc_reg_write16(acc, region, offset, data) 
opae_acc_reg_read8(acc, region, offset, data)
opae_acc_reg_write8(acc, region, offset, data)

OPAE Bridge 

struct opae_bridge * opae_bridge_alloc(const char *name,
			struct opae_bridge_ops *ops, void *data)
int opae_bridge_reset(struct opae_bridge *br)
#define opae_bridge_free(br) opae_free(br)
Level Two Title