Zephyr API Documentation 4.4.0-rc1
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
FPGA Driver Backend API

Data Structures

struct  fpga_driver_api
  Driver Operations FPGA driver operations More...

Typedefs

typedef enum FPGA_status(* fpga_api_get_status) (const struct device *dev)
 Callback API to read FPGA status.
typedef int(* fpga_api_load) (const struct device *dev, uint32_t *image_ptr, uint32_t img_size)
 Callback API to load a bitstream and program the FPGA.
typedef int(* fpga_api_reset) (const struct device *dev)
 Callback API to reset the FPGA.
typedef int(* fpga_api_on) (const struct device *dev)
 Callback API to turn the FPGA on.
typedef int(* fpga_api_off) (const struct device *dev)
 Callback API to turn the FPGA off.
typedef const char *(* fpga_api_get_info) (const struct device *dev)
 Callback API to return information about the FPGA.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a FPGA driver.

Typedef Documentation

◆ fpga_api_get_info

typedef const char *(* fpga_api_get_info) (const struct device *dev)

#include <zephyr/drivers/fpga.h>

Callback API to return information about the FPGA.

See fpga_get_info() for argument description

◆ fpga_api_get_status

typedef enum FPGA_status(* fpga_api_get_status) (const struct device *dev)

#include <zephyr/drivers/fpga.h>

Callback API to read FPGA status.

See fpga_get_status() for argument description

◆ fpga_api_load

typedef int(* fpga_api_load) (const struct device *dev, uint32_t *image_ptr, uint32_t img_size)

#include <zephyr/drivers/fpga.h>

Callback API to load a bitstream and program the FPGA.

See fpga_load() for argument description

◆ fpga_api_off

typedef int(* fpga_api_off) (const struct device *dev)

#include <zephyr/drivers/fpga.h>

Callback API to turn the FPGA off.

See fpga_off() for argument description

◆ fpga_api_on

typedef int(* fpga_api_on) (const struct device *dev)

#include <zephyr/drivers/fpga.h>

Callback API to turn the FPGA on.

See fpga_on() for argument description

◆ fpga_api_reset

typedef int(* fpga_api_reset) (const struct device *dev)

#include <zephyr/drivers/fpga.h>

Callback API to reset the FPGA.

See fpga_reset() for argument description