neorv32_sdi.c File Reference

Serial data interface controller (SDI) HW driver source file. More...

#include "neorv32.h"
#include "neorv32_sdi.h"

Functions
int	neorv32_sdi_available (void)
void	neorv32_sdi_setup (uint32_t irq_mask)
void	neorv32_sdi_rx_clear (void)
void	neorv32_sdi_disable (void)
void	neorv32_sdi_enable (void)
int	neorv32_sdi_get_fifo_depth (void)
int	neorv32_sdi_put (uint8_t data)
void	neorv32_sdi_put_nonblocking (uint8_t data)
int	neorv32_sdi_get (uint8_t *data)
uint8_t	neorv32_sdi_get_nonblocking (void)

Detailed Description

Serial data interface controller (SDI) HW driver source file.

Note

These functions should only be used if the SDI unit was synthesized (IO_SDI_EN = true).

Function Documentation

neorv32_sdi_available()

int neorv32_sdi_available

(

void

)

Check if SDI unit was synthesized.

Returns

0 if SDI was not synthesized, 1 if SPI is available.

neorv32_sdi_disable()

void neorv32_sdi_disable

(

void

)

Disable SDI controller.

neorv32_sdi_enable()

void neorv32_sdi_enable

(

void

)

Enable SDI controller.

neorv32_sdi_get()

int neorv32_sdi_get

(

uint8_t *

data

)

Get data from SDI input FIFO.

Parameters

[in,out]

Pointer

fro data byte read from RX FIFO.

Returns

-1 if RX FIFO is empty.

neorv32_sdi_get_fifo_depth()

int neorv32_sdi_get_fifo_depth

(

void

)

Get SDI FIFO depth.

Returns

FIFO depth (number of entries), zero if no FIFO implemented

neorv32_sdi_get_nonblocking()

uint8_t neorv32_sdi_get_nonblocking

(

void

)

Get data from SDI input FIFO (ignoring RX FIFO status).

Parameters

[in]

data

Byte read from RX FIFO.

neorv32_sdi_put()

int neorv32_sdi_put

(

uint8_t

data

)

Push data to SDI output FIFO.

Parameters

[in]

data

Byte to push into TX FIFO.

Returns

-1 if TX FIFO is full.

neorv32_sdi_put_nonblocking()

void neorv32_sdi_put_nonblocking

(

uint8_t

data

)

Push data to SDI output FIFO (ignoring TX FIFO status).

Parameters

[in]

data

Byte to push into TX FIFO.

neorv32_sdi_rx_clear()

void neorv32_sdi_rx_clear

(

void

)

Clear SDI receive FIFO.

neorv32_sdi_setup()

void neorv32_sdi_setup

(

uint32_t

irq_mask

)

Reset, enable and configure SDI controller. The SDI control register bits are listed in NEORV32_SDI_CTRL_enum.

Parameters

[in]

irq_mask

Interrupt configuration mask (CTRL's irq_* bits).