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

Description

Name: I2C Transmit FIFO Threshold Register

Size: 8 bits

Address Offset: 0x3c

Read/Write Access: Read/Write

Register Layout

Bits Access Reset Description
[7:0] RW 0x0 ALT_I2C_TX_TL_TX_TL
[31:8] ??? 0x0 UNDEFINED

Field : tx_tl

Transmit FIFO Threshold Level

Controls the level of entries (or below) that trigger

the TX_EMPTY interrupt (bit 4 in IC_RAW_INTR_STAT register).

The valid range is 0-255, with the additional restriction that

it may not be set to value larger than the depth of the buffer.

If an attempt is made to do that, the actual value set will be

the maximum depth of the buffer.

A value of 0 sets the threshold for 0 entries, and a value of 255

sets the threshold for 255 entries.

Reset value: IC_TX_TL configuration parameter

Field Access Macros:

#define ALT_I2C_TX_TL_TX_TL_LSB   0
 
#define ALT_I2C_TX_TL_TX_TL_MSB   7
 
#define ALT_I2C_TX_TL_TX_TL_WIDTH   8
 
#define ALT_I2C_TX_TL_TX_TL_SET_MSK   0x000000ff
 
#define ALT_I2C_TX_TL_TX_TL_CLR_MSK   0xffffff00
 
#define ALT_I2C_TX_TL_TX_TL_RESET   0x0
 
#define ALT_I2C_TX_TL_TX_TL_GET(value)   (((value) & 0x000000ff) >> 0)
 
#define ALT_I2C_TX_TL_TX_TL_SET(value)   (((value) << 0) & 0x000000ff)
 

Data Structures

struct  ALT_I2C_TX_TL_s
 

Macros

#define ALT_I2C_TX_TL_RESET   0x00000000
 
#define ALT_I2C_TX_TL_OFST   0x3c
 
#define ALT_I2C_TX_TL_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_I2C_TX_TL_OFST))
 

Typedefs

typedef struct ALT_I2C_TX_TL_s ALT_I2C_TX_TL_t
 

Data Structure Documentation

struct ALT_I2C_TX_TL_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_I2C_TX_TL.

Data Fields
uint32_t tx_tl: 8 ALT_I2C_TX_TL_TX_TL
uint32_t __pad0__: 24 UNDEFINED

Macro Definitions

#define ALT_I2C_TX_TL_TX_TL_LSB   0

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

#define ALT_I2C_TX_TL_TX_TL_MSB   7

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

#define ALT_I2C_TX_TL_TX_TL_WIDTH   8

The width in bits of the ALT_I2C_TX_TL_TX_TL register field.

#define ALT_I2C_TX_TL_TX_TL_SET_MSK   0x000000ff

The mask used to set the ALT_I2C_TX_TL_TX_TL register field value.

#define ALT_I2C_TX_TL_TX_TL_CLR_MSK   0xffffff00

The mask used to clear the ALT_I2C_TX_TL_TX_TL register field value.

#define ALT_I2C_TX_TL_TX_TL_RESET   0x0

The reset value of the ALT_I2C_TX_TL_TX_TL register field.

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

Extracts the ALT_I2C_TX_TL_TX_TL field value from a register.

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

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

#define ALT_I2C_TX_TL_RESET   0x00000000

The reset value of the ALT_I2C_TX_TL register.

#define ALT_I2C_TX_TL_OFST   0x3c

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

#define ALT_I2C_TX_TL_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_I2C_TX_TL_OFST))

The address of the ALT_I2C_TX_TL register.

Typedef Documentation

The typedef declaration for register ALT_I2C_TX_TL.