FPGA

Interfaces for Field-Programmable Gate Arrays (FPGA). More...

Files
file	fpga.h
	Main header file for FPGA driver API.

Data Structures
struct	fpga_driver_api

Macros
#define	FPGA_GET_INFO_DEFAULT   "n/a"

Typedefs
typedef enum FPGA_status(*	fpga_api_get_status) (const struct device *dev)
typedef int(*	fpga_api_load) (const struct device *dev, uint32_t *image_ptr, uint32_t img_size)
typedef int(*	fpga_api_reset) (const struct device *dev)
typedef int(*	fpga_api_on) (const struct device *dev)
typedef int(*	fpga_api_off) (const struct device *dev)
typedef const char *(*	fpga_api_get_info) (const struct device *dev)

Enumerations
enum	FPGA_status { FPGA_STATUS_INACTIVE , FPGA_STATUS_ACTIVE }

Functions
static enum FPGA_status	fpga_get_status (const struct device *dev)
	Read the status of FPGA.
static int	fpga_reset (const struct device *dev)
	Reset the FPGA.
static int	fpga_load (const struct device *dev, uint32_t *image_ptr, uint32_t img_size)
	Load the bitstream and program the FPGA.
static int	fpga_on (const struct device *dev)
	Turns on the FPGA.
static const char *	fpga_get_info (const struct device *dev)
	Returns information about the FPGA.
static int	fpga_off (const struct device *dev)
	Turns off the FPGA.

Detailed Description

Interfaces for Field-Programmable Gate Arrays (FPGA).

Since

2.7

Version

0.1.0

Macro Definition Documentation

FPGA_GET_INFO_DEFAULT

#define FPGA_GET_INFO_DEFAULT   "n/a"

#include <zephyr/drivers/fpga.h>

Typedef Documentation

fpga_api_get_info

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

#include <zephyr/drivers/fpga.h>

fpga_api_get_status

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

#include <zephyr/drivers/fpga.h>

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>

fpga_api_off

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

#include <zephyr/drivers/fpga.h>

fpga_api_on

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

#include <zephyr/drivers/fpga.h>

fpga_api_reset

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

#include <zephyr/drivers/fpga.h>

Enumeration Type Documentation

FPGA_status

enum FPGA_status

#include <zephyr/drivers/fpga.h>

Enumerator
FPGA_STATUS_INACTIVE
FPGA_STATUS_ACTIVE

Function Documentation

fpga_get_info()

const char * fpga_get_info ( const struct device * dev )

inlinestatic

#include <zephyr/drivers/fpga.h>

Returns information about the FPGA.

Parameters

dev	FPGA device structure.

Returns

String containing information.

fpga_get_status()

enum FPGA_status fpga_get_status ( const struct device * dev )

inlinestatic

#include <zephyr/drivers/fpga.h>

Read the status of FPGA.

Parameters

dev	FPGA device structure.

Return values

0	if the FPGA is in INACTIVE state.
1	if the FPGA is in ACTIVE state.

fpga_load()

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

inlinestatic

#include <zephyr/drivers/fpga.h>

Load the bitstream and program the FPGA.

Parameters

dev	FPGA device structure.
image_ptr	Pointer to bitstream.
img_size	Bitstream size in bytes.

Return values

0	if successful.
Failed	Otherwise.

fpga_off()

int fpga_off ( const struct device * dev )

inlinestatic

#include <zephyr/drivers/fpga.h>

Turns off the FPGA.

Parameters

dev	FPGA device structure.

Return values

0	if successful.
negative	errno code on failure.

fpga_on()

int fpga_on ( const struct device * dev )

inlinestatic

#include <zephyr/drivers/fpga.h>

Turns on the FPGA.

Parameters

dev	FPGA device structure.

Return values

0	if successful.
negative	errno code on failure.

fpga_reset()

int fpga_reset ( const struct device * dev )

inlinestatic

#include <zephyr/drivers/fpga.h>

Reset the FPGA.

Parameters

dev	FPGA device structure.

Return values

0	if successful.
Failed	Otherwise.