Altera SoCAL  16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
 All Data Structures Variables Typedefs Groups
Register : scr

Description

Scratchpad Register

Register Layout

Bits Access Reset Description
[7:0] RW 0x0 ALT_UART_SCR_SCR
[31:8] R 0x0 ALT_UART_SCR_RSVD_SCR_31TO8

Field : scr

This register is for programmers to use as a temporary storage space. It has no

defined purpose in the DW_apb_uart.

Field Access Macros:

#define ALT_UART_SCR_SCR_LSB   0
 
#define ALT_UART_SCR_SCR_MSB   7
 
#define ALT_UART_SCR_SCR_WIDTH   8
 
#define ALT_UART_SCR_SCR_SET_MSK   0x000000ff
 
#define ALT_UART_SCR_SCR_CLR_MSK   0xffffff00
 
#define ALT_UART_SCR_SCR_RESET   0x0
 
#define ALT_UART_SCR_SCR_GET(value)   (((value) & 0x000000ff) >> 0)
 
#define ALT_UART_SCR_SCR_SET(value)   (((value) << 0) & 0x000000ff)
 

Field : rsvd_scr_31to8

Reserved bits [31:8] - Read Only

Field Access Macros:

#define ALT_UART_SCR_RSVD_SCR_31TO8_LSB   8
 
#define ALT_UART_SCR_RSVD_SCR_31TO8_MSB   31
 
#define ALT_UART_SCR_RSVD_SCR_31TO8_WIDTH   24
 
#define ALT_UART_SCR_RSVD_SCR_31TO8_SET_MSK   0xffffff00
 
#define ALT_UART_SCR_RSVD_SCR_31TO8_CLR_MSK   0x000000ff
 
#define ALT_UART_SCR_RSVD_SCR_31TO8_RESET   0x0
 
#define ALT_UART_SCR_RSVD_SCR_31TO8_GET(value)   (((value) & 0xffffff00) >> 8)
 
#define ALT_UART_SCR_RSVD_SCR_31TO8_SET(value)   (((value) << 8) & 0xffffff00)
 

Data Structures

struct  ALT_UART_SCR_s
 

Macros

#define ALT_UART_SCR_RESET   0x00000000
 
#define ALT_UART_SCR_OFST   0x1c
 
#define ALT_UART_SCR_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_SCR_OFST))
 

Typedefs

typedef struct ALT_UART_SCR_s ALT_UART_SCR_t
 

Data Structure Documentation

struct ALT_UART_SCR_s

WARNING: The C register and register group struct declarations are provided for convenience and illustrative purposes. They should, however, be used with caution as the C language standard provides no guarantees about the alignment or atomicity of device memory accesses. The recommended practice for writing hardware drivers is to use the SoCAL access macros and alt_read_word() and alt_write_word() functions.

The struct declaration for register ALT_UART_SCR.

Data Fields
uint32_t scr: 8 ALT_UART_SCR_SCR
const uint32_t rsvd_scr_31to8: 24 ALT_UART_SCR_RSVD_SCR_31TO8

Macro Definitions

#define ALT_UART_SCR_SCR_LSB   0

The Least Significant Bit (LSB) position of the ALT_UART_SCR_SCR register field.

#define ALT_UART_SCR_SCR_MSB   7

The Most Significant Bit (MSB) position of the ALT_UART_SCR_SCR register field.

#define ALT_UART_SCR_SCR_WIDTH   8

The width in bits of the ALT_UART_SCR_SCR register field.

#define ALT_UART_SCR_SCR_SET_MSK   0x000000ff

The mask used to set the ALT_UART_SCR_SCR register field value.

#define ALT_UART_SCR_SCR_CLR_MSK   0xffffff00

The mask used to clear the ALT_UART_SCR_SCR register field value.

#define ALT_UART_SCR_SCR_RESET   0x0

The reset value of the ALT_UART_SCR_SCR register field.

#define ALT_UART_SCR_SCR_GET (   value)    (((value) & 0x000000ff) >> 0)

Extracts the ALT_UART_SCR_SCR field value from a register.

#define ALT_UART_SCR_SCR_SET (   value)    (((value) << 0) & 0x000000ff)

Produces a ALT_UART_SCR_SCR register field value suitable for setting the register.

#define ALT_UART_SCR_RSVD_SCR_31TO8_LSB   8

The Least Significant Bit (LSB) position of the ALT_UART_SCR_RSVD_SCR_31TO8 register field.

#define ALT_UART_SCR_RSVD_SCR_31TO8_MSB   31

The Most Significant Bit (MSB) position of the ALT_UART_SCR_RSVD_SCR_31TO8 register field.

#define ALT_UART_SCR_RSVD_SCR_31TO8_WIDTH   24

The width in bits of the ALT_UART_SCR_RSVD_SCR_31TO8 register field.

#define ALT_UART_SCR_RSVD_SCR_31TO8_SET_MSK   0xffffff00

The mask used to set the ALT_UART_SCR_RSVD_SCR_31TO8 register field value.

#define ALT_UART_SCR_RSVD_SCR_31TO8_CLR_MSK   0x000000ff

The mask used to clear the ALT_UART_SCR_RSVD_SCR_31TO8 register field value.

#define ALT_UART_SCR_RSVD_SCR_31TO8_RESET   0x0

The reset value of the ALT_UART_SCR_RSVD_SCR_31TO8 register field.

#define ALT_UART_SCR_RSVD_SCR_31TO8_GET (   value)    (((value) & 0xffffff00) >> 8)

Extracts the ALT_UART_SCR_RSVD_SCR_31TO8 field value from a register.

#define ALT_UART_SCR_RSVD_SCR_31TO8_SET (   value)    (((value) << 8) & 0xffffff00)

Produces a ALT_UART_SCR_RSVD_SCR_31TO8 register field value suitable for setting the register.

#define ALT_UART_SCR_RESET   0x00000000

The reset value of the ALT_UART_SCR register.

#define ALT_UART_SCR_OFST   0x1c

The byte offset of the ALT_UART_SCR register from the beginning of the component.

#define ALT_UART_SCR_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_UART_SCR_OFST))

The address of the ALT_UART_SCR register.

Typedef Documentation

The typedef declaration for register ALT_UART_SCR.