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

Description

The Message Object Mask Bits together with the arbitration bits are used for acceptance filtering of incoming messages.

Note: While IFxCMR.Busy bit is one, the IF1/2 Register Set is write protected.

Register Layout

Bits Access Reset Description
[28:0] RW 0x1fffffff Identifier Mask
[29] ??? 0x1 UNDEFINED
[30] RW 0x1 Mask Message Direction
[31] RW 0x1 Mask Extended Identifier

Field : Identifier Mask - Msk

0 = The corresponding bit in the identifier of the message object cannot inhibit the match in the acceptance filtering.

1 = The corresponding identifier bit is used for acceptance filtering.

Field Access Macros:

#define ALT_CAN_MSGIF_IF2MSK_MSK_LSB   0
 
#define ALT_CAN_MSGIF_IF2MSK_MSK_MSB   28
 
#define ALT_CAN_MSGIF_IF2MSK_MSK_WIDTH   29
 
#define ALT_CAN_MSGIF_IF2MSK_MSK_SET_MSK   0x1fffffff
 
#define ALT_CAN_MSGIF_IF2MSK_MSK_CLR_MSK   0xe0000000
 
#define ALT_CAN_MSGIF_IF2MSK_MSK_RESET   0x1fffffff
 
#define ALT_CAN_MSGIF_IF2MSK_MSK_GET(value)   (((value) & 0x1fffffff) >> 0)
 
#define ALT_CAN_MSGIF_IF2MSK_MSK_SET(value)   (((value) << 0) & 0x1fffffff)
 

Field : Mask Message Direction - MDir

Field Enumeration Values:

Enum Value Description
ALT_CAN_MSGIF_IF2MSK_MDIR_E_NOACCEPTEFFECT 0x0 The message direction bit (Dir) has no effect on
: the acceptance filtering. Handle with care
: setting IFxMSK.MDir to zero.
ALT_CAN_MSGIF_IF2MSK_MDIR_E_ACCEPTEFFECT 0x1 The message direction bit (Dir) is used for
: acceptance filtering.

Field Access Macros:

#define ALT_CAN_MSGIF_IF2MSK_MDIR_E_NOACCEPTEFFECT   0x0
 
#define ALT_CAN_MSGIF_IF2MSK_MDIR_E_ACCEPTEFFECT   0x1
 
#define ALT_CAN_MSGIF_IF2MSK_MDIR_LSB   30
 
#define ALT_CAN_MSGIF_IF2MSK_MDIR_MSB   30
 
#define ALT_CAN_MSGIF_IF2MSK_MDIR_WIDTH   1
 
#define ALT_CAN_MSGIF_IF2MSK_MDIR_SET_MSK   0x40000000
 
#define ALT_CAN_MSGIF_IF2MSK_MDIR_CLR_MSK   0xbfffffff
 
#define ALT_CAN_MSGIF_IF2MSK_MDIR_RESET   0x1
 
#define ALT_CAN_MSGIF_IF2MSK_MDIR_GET(value)   (((value) & 0x40000000) >> 30)
 
#define ALT_CAN_MSGIF_IF2MSK_MDIR_SET(value)   (((value) << 30) & 0x40000000)
 

Field : Mask Extended Identifier - MXtd

When 11-bit (standard) Identifiers are used for a Message Object, the identifiers of received Data Frames are written into bits ID28 to ID18. For acceptance filtering, only these bits together with mask bits Msk28 to Msk18 are considered.

Field Enumeration Values:

Enum Value Description
ALT_CAN_MSGIF_IF2MSK_MXTD_E_NOACCEPTEFFECT 0x0 The extended identifier bit (IDE) has no effect
: on the acceptance filtering.
ALT_CAN_MSGIF_IF2MSK_MXTD_E_ACCEPTEFFECT 0x1 The extended identifier bit (IDE) is used for
: acceptance filtering.

Field Access Macros:

#define ALT_CAN_MSGIF_IF2MSK_MXTD_E_NOACCEPTEFFECT   0x0
 
#define ALT_CAN_MSGIF_IF2MSK_MXTD_E_ACCEPTEFFECT   0x1
 
#define ALT_CAN_MSGIF_IF2MSK_MXTD_LSB   31
 
#define ALT_CAN_MSGIF_IF2MSK_MXTD_MSB   31
 
#define ALT_CAN_MSGIF_IF2MSK_MXTD_WIDTH   1
 
#define ALT_CAN_MSGIF_IF2MSK_MXTD_SET_MSK   0x80000000
 
#define ALT_CAN_MSGIF_IF2MSK_MXTD_CLR_MSK   0x7fffffff
 
#define ALT_CAN_MSGIF_IF2MSK_MXTD_RESET   0x1
 
#define ALT_CAN_MSGIF_IF2MSK_MXTD_GET(value)   (((value) & 0x80000000) >> 31)
 
#define ALT_CAN_MSGIF_IF2MSK_MXTD_SET(value)   (((value) << 31) & 0x80000000)
 

Data Structures

struct  ALT_CAN_MSGIF_IF2MSK_s
 

Macros

#define ALT_CAN_MSGIF_IF2MSK_OFST   0x24
 
#define ALT_CAN_MSGIF_IF2MSK_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_CAN_MSGIF_IF2MSK_OFST))
 

Typedefs

typedef struct
ALT_CAN_MSGIF_IF2MSK_s 
ALT_CAN_MSGIF_IF2MSK_t
 

Data Structure Documentation

struct ALT_CAN_MSGIF_IF2MSK_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_MSGIF_IF2MSK.

Data Fields
uint32_t Msk: 29 Identifier Mask
uint32_t __pad0__: 1 UNDEFINED
uint32_t MDir: 1 Mask Message Direction
uint32_t MXtd: 1 Mask Extended Identifier

Macro Definitions

#define ALT_CAN_MSGIF_IF2MSK_MSK_LSB   0

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

#define ALT_CAN_MSGIF_IF2MSK_MSK_MSB   28

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

#define ALT_CAN_MSGIF_IF2MSK_MSK_WIDTH   29

The width in bits of the ALT_CAN_MSGIF_IF2MSK_MSK register field.

#define ALT_CAN_MSGIF_IF2MSK_MSK_SET_MSK   0x1fffffff

The mask used to set the ALT_CAN_MSGIF_IF2MSK_MSK register field value.

#define ALT_CAN_MSGIF_IF2MSK_MSK_CLR_MSK   0xe0000000

The mask used to clear the ALT_CAN_MSGIF_IF2MSK_MSK register field value.

#define ALT_CAN_MSGIF_IF2MSK_MSK_RESET   0x1fffffff

The reset value of the ALT_CAN_MSGIF_IF2MSK_MSK register field.

#define ALT_CAN_MSGIF_IF2MSK_MSK_GET (   value)    (((value) & 0x1fffffff) >> 0)

Extracts the ALT_CAN_MSGIF_IF2MSK_MSK field value from a register.

#define ALT_CAN_MSGIF_IF2MSK_MSK_SET (   value)    (((value) << 0) & 0x1fffffff)

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

#define ALT_CAN_MSGIF_IF2MSK_MDIR_E_NOACCEPTEFFECT   0x0

Enumerated value for register field ALT_CAN_MSGIF_IF2MSK_MDIR

The message direction bit (Dir) has no effect on the acceptance filtering. Handle with care setting IFxMSK.MDir to zero.

#define ALT_CAN_MSGIF_IF2MSK_MDIR_E_ACCEPTEFFECT   0x1

Enumerated value for register field ALT_CAN_MSGIF_IF2MSK_MDIR

The message direction bit (Dir) is used for acceptance filtering.

#define ALT_CAN_MSGIF_IF2MSK_MDIR_LSB   30

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

#define ALT_CAN_MSGIF_IF2MSK_MDIR_MSB   30

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

#define ALT_CAN_MSGIF_IF2MSK_MDIR_WIDTH   1

The width in bits of the ALT_CAN_MSGIF_IF2MSK_MDIR register field.

#define ALT_CAN_MSGIF_IF2MSK_MDIR_SET_MSK   0x40000000

The mask used to set the ALT_CAN_MSGIF_IF2MSK_MDIR register field value.

#define ALT_CAN_MSGIF_IF2MSK_MDIR_CLR_MSK   0xbfffffff

The mask used to clear the ALT_CAN_MSGIF_IF2MSK_MDIR register field value.

#define ALT_CAN_MSGIF_IF2MSK_MDIR_RESET   0x1

The reset value of the ALT_CAN_MSGIF_IF2MSK_MDIR register field.

#define ALT_CAN_MSGIF_IF2MSK_MDIR_GET (   value)    (((value) & 0x40000000) >> 30)

Extracts the ALT_CAN_MSGIF_IF2MSK_MDIR field value from a register.

#define ALT_CAN_MSGIF_IF2MSK_MDIR_SET (   value)    (((value) << 30) & 0x40000000)

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

#define ALT_CAN_MSGIF_IF2MSK_MXTD_E_NOACCEPTEFFECT   0x0

Enumerated value for register field ALT_CAN_MSGIF_IF2MSK_MXTD

The extended identifier bit (IDE) has no effect on the acceptance filtering.

#define ALT_CAN_MSGIF_IF2MSK_MXTD_E_ACCEPTEFFECT   0x1

Enumerated value for register field ALT_CAN_MSGIF_IF2MSK_MXTD

The extended identifier bit (IDE) is used for acceptance filtering.

#define ALT_CAN_MSGIF_IF2MSK_MXTD_LSB   31

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

#define ALT_CAN_MSGIF_IF2MSK_MXTD_MSB   31

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

#define ALT_CAN_MSGIF_IF2MSK_MXTD_WIDTH   1

The width in bits of the ALT_CAN_MSGIF_IF2MSK_MXTD register field.

#define ALT_CAN_MSGIF_IF2MSK_MXTD_SET_MSK   0x80000000

The mask used to set the ALT_CAN_MSGIF_IF2MSK_MXTD register field value.

#define ALT_CAN_MSGIF_IF2MSK_MXTD_CLR_MSK   0x7fffffff

The mask used to clear the ALT_CAN_MSGIF_IF2MSK_MXTD register field value.

#define ALT_CAN_MSGIF_IF2MSK_MXTD_RESET   0x1

The reset value of the ALT_CAN_MSGIF_IF2MSK_MXTD register field.

#define ALT_CAN_MSGIF_IF2MSK_MXTD_GET (   value)    (((value) & 0x80000000) >> 31)

Extracts the ALT_CAN_MSGIF_IF2MSK_MXTD field value from a register.

#define ALT_CAN_MSGIF_IF2MSK_MXTD_SET (   value)    (((value) << 31) & 0x80000000)

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

#define ALT_CAN_MSGIF_IF2MSK_OFST   0x24

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

#define ALT_CAN_MSGIF_IF2MSK_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_CAN_MSGIF_IF2MSK_OFST))

The address of the ALT_CAN_MSGIF_IF2MSK register.

Typedef Documentation

The typedef declaration for register ALT_CAN_MSGIF_IF2MSK.