Software APIs
Data Structures | Typedefs | Enumerations | Functions
dif_uart_autogen.h File Reference

(d77a3a3)

UART Device Interface Functions More...

#include <stdbool.h>
#include <stdint.h>
#include "sw/device/lib/base/macros.h"
#include "sw/device/lib/base/mmio.h"
#include "sw/device/lib/dif/dif_base.h"

Go to the source code of this file.

Data Structures

struct  dif_uart
 A handle to uart. More...
 

Typedefs

typedef struct dif_uart dif_uart_t
 A handle to uart. More...
 
typedef enum dif_uart_alert dif_uart_alert_t
 A uart alert type.
 
typedef enum dif_uart_irq dif_uart_irq_t
 A uart interrupt request type.
 
typedef uint32_t dif_uart_irq_state_snapshot_t
 A snapshot of the state of the interrupts for this IP. More...
 
typedef uint32_t dif_uart_irq_enable_snapshot_t
 A snapshot of the enablement state of the interrupts for this IP. More...
 

Enumerations

enum  dif_uart_alert { kDifUartAlertFatalFault = 0 }
 A uart alert type. More...
 
enum  dif_uart_irq {
  kDifUartIrqTxWatermark = 0,
  kDifUartIrqRxWatermark = 1,
  kDifUartIrqTxEmpty = 2,
  kDifUartIrqRxOverflow = 3,
  kDifUartIrqRxFrameErr = 4,
  kDifUartIrqRxBreakErr = 5,
  kDifUartIrqRxTimeout = 6,
  kDifUartIrqRxParityErr = 7
}
 A uart interrupt request type. More...
 

Functions

OT_WARN_UNUSED_RESULT dif_result_t dif_uart_init (mmio_region_t base_addr, dif_uart_t *uart)
 Creates a new handle for a(n) uart peripheral. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_uart_alert_force (const dif_uart_t *uart, dif_uart_alert_t alert)
 Forces a particular alert, causing it to be escalated as if the hardware had raised it. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_get_type (const dif_uart_t *uart, dif_uart_irq_t irq, dif_irq_type_t *type)
 Returns the type of a given interrupt (i.e., event or status) for this IP. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_get_state (const dif_uart_t *uart, dif_uart_irq_state_snapshot_t *snapshot)
 Returns the state of all interrupts (i.e., pending or not) for this IP. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_is_pending (const dif_uart_t *uart, dif_uart_irq_t irq, bool *is_pending)
 Returns whether a particular interrupt is currently pending. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_acknowledge_state (const dif_uart_t *uart, dif_uart_irq_state_snapshot_t snapshot)
 Acknowledges all interrupts that were pending at the time of the state snapshot. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_acknowledge_all (const dif_uart_t *uart)
 Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_acknowledge (const dif_uart_t *uart, dif_uart_irq_t irq)
 Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_force (const dif_uart_t *uart, dif_uart_irq_t irq, const bool val)
 Forces a particular interrupt, causing it to be serviced as if hardware had asserted it. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_get_enabled (const dif_uart_t *uart, dif_uart_irq_t irq, dif_toggle_t *state)
 Checks whether a particular interrupt is currently enabled or disabled. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_set_enabled (const dif_uart_t *uart, dif_uart_irq_t irq, dif_toggle_t state)
 Sets whether a particular interrupt is currently enabled or disabled. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_disable_all (const dif_uart_t *uart, dif_uart_irq_enable_snapshot_t *snapshot)
 Disables all interrupts, optionally snapshotting all enable states for later restoration. More...
 
OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_restore_all (const dif_uart_t *uart, const dif_uart_irq_enable_snapshot_t *snapshot)
 Restores interrupts from the given (enable) snapshot. More...
 

Detailed Description

UART Device Interface Functions

Definition in file dif_uart_autogen.h.


Data Structure Documentation

◆ dif_uart

struct dif_uart

A handle to uart.

This type should be treated as opaque by users.

Definition at line 32 of file dif_uart_autogen.h.

Data Fields
mmio_region_t base_addr The base address for the uart hardware registers.

Typedef Documentation

◆ dif_uart_irq_enable_snapshot_t

A snapshot of the enablement state of the interrupts for this IP.

This is an opaque type, to be used with the dif_uart_irq_disable_all() and dif_uart_irq_restore_all() functions.

Definition at line 210 of file dif_uart_autogen.h.

◆ dif_uart_irq_state_snapshot_t

A snapshot of the state of the interrupts for this IP.

This is an opaque type, to be used with the dif_uart_irq_get_state() and dif_uart_irq_acknowledge_state() functions.

Definition at line 119 of file dif_uart_autogen.h.

◆ dif_uart_t

typedef struct dif_uart dif_uart_t

A handle to uart.

This type should be treated as opaque by users.

Enumeration Type Documentation

◆ dif_uart_alert

A uart alert type.

Enumerator
kDifUartAlertFatalFault 

This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.

Definition at line 54 of file dif_uart_autogen.h.

◆ dif_uart_irq

A uart interrupt request type.

Enumerator
kDifUartIrqTxWatermark 

Raised if the transmit FIFO is past the high-water mark.

kDifUartIrqRxWatermark 

Raised if the receive FIFO is past the high-water mark.

kDifUartIrqTxEmpty 

Raised if the transmit FIFO has emptied and no transmit is ongoing.

kDifUartIrqRxOverflow 

Raised if the receive FIFO has overflowed.

kDifUartIrqRxFrameErr 

Raised if a framing error has been detected on receive.

kDifUartIrqRxBreakErr 

Raised if break condition has been detected on receive.

kDifUartIrqRxTimeout 

Raised if RX FIFO has characters remaining in the FIFO without being retrieved for the programmed time period.

kDifUartIrqRxParityErr 

Raised if the receiver has detected a parity error.

Definition at line 77 of file dif_uart_autogen.h.

Function Documentation

◆ dif_uart_alert_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_uart_alert_force ( const dif_uart_t uart,
dif_uart_alert_t  alert 
)

Forces a particular alert, causing it to be escalated as if the hardware had raised it.

Parameters
uartA uart handle.
alertThe alert to force.
Returns
The result of the operation.

Definition at line 27 of file dif_uart_autogen.c.

◆ dif_uart_init()

OT_WARN_UNUSED_RESULT dif_result_t dif_uart_init ( mmio_region_t  base_addr,
dif_uart_t uart 
)

Creates a new handle for a(n) uart peripheral.

This function does not actuate the hardware.

Parameters
base_addrThe MMIO base address of the uart peripheral.
[out]uartOut param for the initialized handle.
Returns
The result of the operation.

Definition at line 17 of file dif_uart_autogen.c.

◆ dif_uart_irq_acknowledge()

OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_acknowledge ( const dif_uart_t uart,
dif_uart_irq_t  irq 
)

Acknowledges a particular interrupt, indicating to the hardware that it has been successfully serviced.

Parameters
uartA uart handle.
irqAn interrupt request.
Returns
The result of the operation.

Definition at line 163 of file dif_uart_autogen.c.

◆ dif_uart_irq_acknowledge_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_acknowledge_all ( const dif_uart_t uart)

Acknowledges all interrupts, indicating to the hardware that all interrupts have been successfully serviced.

Parameters
uartA uart handle.
Returns
The result of the operation.

Definition at line 150 of file dif_uart_autogen.c.

◆ dif_uart_irq_acknowledge_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_acknowledge_state ( const dif_uart_t uart,
dif_uart_irq_state_snapshot_t  snapshot 
)

Acknowledges all interrupts that were pending at the time of the state snapshot.

Parameters
uartA uart handle.
snapshotInterrupt state snapshot.
Returns
The result of the operation.

Definition at line 117 of file dif_uart_autogen.c.

◆ dif_uart_irq_disable_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_disable_all ( const dif_uart_t uart,
dif_uart_irq_enable_snapshot_t snapshot 
)

Disables all interrupts, optionally snapshotting all enable states for later restoration.

Parameters
uartA uart handle.
[out]snapshotOut-param for the snapshot; may be NULL.
Returns
The result of the operation.

Definition at line 246 of file dif_uart_autogen.c.

◆ dif_uart_irq_force()

OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_force ( const dif_uart_t uart,
dif_uart_irq_t  irq,
const bool  val 
)

Forces a particular interrupt, causing it to be serviced as if hardware had asserted it.

Parameters
uartA uart handle.
irqAn interrupt request.
valValue to be set.
Returns
The result of the operation.

Definition at line 183 of file dif_uart_autogen.c.

◆ dif_uart_irq_get_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_get_enabled ( const dif_uart_t uart,
dif_uart_irq_t  irq,
dif_toggle_t state 
)

Checks whether a particular interrupt is currently enabled or disabled.

Parameters
uartA uart handle.
irqAn interrupt request.
[out]stateOut-param toggle state of the interrupt.
Returns
The result of the operation.

Definition at line 202 of file dif_uart_autogen.c.

◆ dif_uart_irq_get_state()

OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_get_state ( const dif_uart_t uart,
dif_uart_irq_state_snapshot_t snapshot 
)

Returns the state of all interrupts (i.e., pending or not) for this IP.

Parameters
uartA uart handle.
[out]snapshotOut-param for interrupt state snapshot.
Returns
The result of the operation.

Definition at line 104 of file dif_uart_autogen.c.

◆ dif_uart_irq_get_type()

OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_get_type ( const dif_uart_t uart,
dif_uart_irq_t  irq,
dif_irq_type_t type 
)

Returns the type of a given interrupt (i.e., event or status) for this IP.

Parameters
uartA uart handle.
irqAn interrupt request.
[out]typeOut-param for the interrupt type.
Returns
The result of the operation.

Definition at line 92 of file dif_uart_autogen.c.

◆ dif_uart_irq_is_pending()

OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_is_pending ( const dif_uart_t uart,
dif_uart_irq_t  irq,
bool *  is_pending 
)

Returns whether a particular interrupt is currently pending.

Parameters
uartA uart handle.
irqAn interrupt request.
[out]is_pendingOut-param for whether the interrupt is pending.
Returns
The result of the operation.

Definition at line 130 of file dif_uart_autogen.c.

◆ dif_uart_irq_restore_all()

OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_restore_all ( const dif_uart_t uart,
const dif_uart_irq_enable_snapshot_t snapshot 
)

Restores interrupts from the given (enable) snapshot.

Parameters
uartA uart handle.
snapshotA snapshot to restore from.
Returns
The result of the operation.

Definition at line 266 of file dif_uart_autogen.c.

◆ dif_uart_irq_set_enabled()

OT_WARN_UNUSED_RESULT dif_result_t dif_uart_irq_set_enabled ( const dif_uart_t uart,
dif_uart_irq_t  irq,
dif_toggle_t  state 
)

Sets whether a particular interrupt is currently enabled or disabled.

Parameters
uartA uart handle.
irqAn interrupt request.
stateThe new toggle state for the interrupt.
Returns
The result of the operation.

Definition at line 223 of file dif_uart_autogen.c.