Altera SoCAL  16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
 All Data Structures Variables Typedefs Groups
Register : Hardware Configuration Status Register - HWS

Description

Hardware Configuration Status Register

Register Layout

Bits Access Reset Description
[1:0] R 0x3 Message Buffer Count
[2] R 0x0 Parity Generation
[31:3] ??? 0x0 UNDEFINED

Field : Message Buffer Count - mb_w

Message Buffer Count

Field Enumeration Values:

Enum Value Description
ALT_CAN_PROTO_HWS_MB_W_E_MSGOBJS16 0x0 16 Message Objects
ALT_CAN_PROTO_HWS_MB_W_E_MSGOBJS32 0x1 32 Message Objects
ALT_CAN_PROTO_HWS_MB_W_E_MSGOBJS64 0x2 64 Message Objects
ALT_CAN_PROTO_HWS_MB_W_E_MSGOBJS128 0x3 128 Message Objects

Field Access Macros:

#define ALT_CAN_PROTO_HWS_MB_W_E_MSGOBJS16   0x0
 
#define ALT_CAN_PROTO_HWS_MB_W_E_MSGOBJS32   0x1
 
#define ALT_CAN_PROTO_HWS_MB_W_E_MSGOBJS64   0x2
 
#define ALT_CAN_PROTO_HWS_MB_W_E_MSGOBJS128   0x3
 
#define ALT_CAN_PROTO_HWS_MB_W_LSB   0
 
#define ALT_CAN_PROTO_HWS_MB_W_MSB   1
 
#define ALT_CAN_PROTO_HWS_MB_W_WIDTH   2
 
#define ALT_CAN_PROTO_HWS_MB_W_SET_MSK   0x00000003
 
#define ALT_CAN_PROTO_HWS_MB_W_CLR_MSK   0xfffffffc
 
#define ALT_CAN_PROTO_HWS_MB_W_RESET   0x3
 
#define ALT_CAN_PROTO_HWS_MB_W_GET(value)   (((value) & 0x00000003) >> 0)
 
#define ALT_CAN_PROTO_HWS_MB_W_SET(value)   (((value) << 0) & 0x00000003)
 

Field : Parity Generation - paren

Parity Generation

Field Enumeration Values:

Enum Value Description
ALT_CAN_PROTO_HWS_PAREN_E_NOTPRESENT 0x0 Parity generation harware is not present.
ALT_CAN_PROTO_HWS_PAREN_E_PRESENT 0x1 Parity generation harware is present.

Field Access Macros:

#define ALT_CAN_PROTO_HWS_PAREN_E_NOTPRESENT   0x0
 
#define ALT_CAN_PROTO_HWS_PAREN_E_PRESENT   0x1
 
#define ALT_CAN_PROTO_HWS_PAREN_LSB   2
 
#define ALT_CAN_PROTO_HWS_PAREN_MSB   2
 
#define ALT_CAN_PROTO_HWS_PAREN_WIDTH   1
 
#define ALT_CAN_PROTO_HWS_PAREN_SET_MSK   0x00000004
 
#define ALT_CAN_PROTO_HWS_PAREN_CLR_MSK   0xfffffffb
 
#define ALT_CAN_PROTO_HWS_PAREN_RESET   0x0
 
#define ALT_CAN_PROTO_HWS_PAREN_GET(value)   (((value) & 0x00000004) >> 2)
 
#define ALT_CAN_PROTO_HWS_PAREN_SET(value)   (((value) << 2) & 0x00000004)
 

Data Structures

struct  ALT_CAN_PROTO_HWS_s
 

Macros

#define ALT_CAN_PROTO_HWS_OFST   0x24
 
#define ALT_CAN_PROTO_HWS_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_CAN_PROTO_HWS_OFST))
 

Typedefs

typedef struct ALT_CAN_PROTO_HWS_s ALT_CAN_PROTO_HWS_t
 

Data Structure Documentation

struct ALT_CAN_PROTO_HWS_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_CAN_PROTO_HWS.

Data Fields
const uint32_t mb_w: 2 Message Buffer Count
const uint32_t paren: 1 Parity Generation
uint32_t __pad0__: 29 UNDEFINED

Macro Definitions

#define ALT_CAN_PROTO_HWS_MB_W_E_MSGOBJS16   0x0

Enumerated value for register field ALT_CAN_PROTO_HWS_MB_W

16 Message Objects

#define ALT_CAN_PROTO_HWS_MB_W_E_MSGOBJS32   0x1

Enumerated value for register field ALT_CAN_PROTO_HWS_MB_W

32 Message Objects

#define ALT_CAN_PROTO_HWS_MB_W_E_MSGOBJS64   0x2

Enumerated value for register field ALT_CAN_PROTO_HWS_MB_W

64 Message Objects

#define ALT_CAN_PROTO_HWS_MB_W_E_MSGOBJS128   0x3

Enumerated value for register field ALT_CAN_PROTO_HWS_MB_W

128 Message Objects

#define ALT_CAN_PROTO_HWS_MB_W_LSB   0

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

#define ALT_CAN_PROTO_HWS_MB_W_MSB   1

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

#define ALT_CAN_PROTO_HWS_MB_W_WIDTH   2

The width in bits of the ALT_CAN_PROTO_HWS_MB_W register field.

#define ALT_CAN_PROTO_HWS_MB_W_SET_MSK   0x00000003

The mask used to set the ALT_CAN_PROTO_HWS_MB_W register field value.

#define ALT_CAN_PROTO_HWS_MB_W_CLR_MSK   0xfffffffc

The mask used to clear the ALT_CAN_PROTO_HWS_MB_W register field value.

#define ALT_CAN_PROTO_HWS_MB_W_RESET   0x3

The reset value of the ALT_CAN_PROTO_HWS_MB_W register field.

#define ALT_CAN_PROTO_HWS_MB_W_GET (   value)    (((value) & 0x00000003) >> 0)

Extracts the ALT_CAN_PROTO_HWS_MB_W field value from a register.

#define ALT_CAN_PROTO_HWS_MB_W_SET (   value)    (((value) << 0) & 0x00000003)

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

#define ALT_CAN_PROTO_HWS_PAREN_E_NOTPRESENT   0x0

Enumerated value for register field ALT_CAN_PROTO_HWS_PAREN

Parity generation harware is not present.

#define ALT_CAN_PROTO_HWS_PAREN_E_PRESENT   0x1

Enumerated value for register field ALT_CAN_PROTO_HWS_PAREN

Parity generation harware is present.

#define ALT_CAN_PROTO_HWS_PAREN_LSB   2

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

#define ALT_CAN_PROTO_HWS_PAREN_MSB   2

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

#define ALT_CAN_PROTO_HWS_PAREN_WIDTH   1

The width in bits of the ALT_CAN_PROTO_HWS_PAREN register field.

#define ALT_CAN_PROTO_HWS_PAREN_SET_MSK   0x00000004

The mask used to set the ALT_CAN_PROTO_HWS_PAREN register field value.

#define ALT_CAN_PROTO_HWS_PAREN_CLR_MSK   0xfffffffb

The mask used to clear the ALT_CAN_PROTO_HWS_PAREN register field value.

#define ALT_CAN_PROTO_HWS_PAREN_RESET   0x0

The reset value of the ALT_CAN_PROTO_HWS_PAREN register field.

#define ALT_CAN_PROTO_HWS_PAREN_GET (   value)    (((value) & 0x00000004) >> 2)

Extracts the ALT_CAN_PROTO_HWS_PAREN field value from a register.

#define ALT_CAN_PROTO_HWS_PAREN_SET (   value)    (((value) << 2) & 0x00000004)

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

#define ALT_CAN_PROTO_HWS_OFST   0x24

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

#define ALT_CAN_PROTO_HWS_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_CAN_PROTO_HWS_OFST))

The address of the ALT_CAN_PROTO_HWS register.

Typedef Documentation

The typedef declaration for register ALT_CAN_PROTO_HWS.