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

Description

This register controls the amount of time delay (in terms of number of l4_sp_clk clock periods) introduced in the falling edge of SCL, relative to SDA changing, when I2C services a read request in a slave-transmitter operation. The relevant I2C requirement is thd:DAT as detailed in the I2C Bus Specification.

Register Layout

Bits Access Reset Description
[15:0] RW 0x1 SDA Hold Bit
[31:16] ??? 0x0 UNDEFINED

Field : SDA Hold Bit - ic_sda_hold

Program to a minimum 0f 300ns.

Field Access Macros:

#define ALT_I2C_SDA_HOLD_IC_SDA_HOLD_LSB   0
 
#define ALT_I2C_SDA_HOLD_IC_SDA_HOLD_MSB   15
 
#define ALT_I2C_SDA_HOLD_IC_SDA_HOLD_WIDTH   16
 
#define ALT_I2C_SDA_HOLD_IC_SDA_HOLD_SET_MSK   0x0000ffff
 
#define ALT_I2C_SDA_HOLD_IC_SDA_HOLD_CLR_MSK   0xffff0000
 
#define ALT_I2C_SDA_HOLD_IC_SDA_HOLD_RESET   0x1
 
#define ALT_I2C_SDA_HOLD_IC_SDA_HOLD_GET(value)   (((value) & 0x0000ffff) >> 0)
 
#define ALT_I2C_SDA_HOLD_IC_SDA_HOLD_SET(value)   (((value) << 0) & 0x0000ffff)
 

Data Structures

struct  ALT_I2C_SDA_HOLD_s
 

Macros

#define ALT_I2C_SDA_HOLD_OFST   0x7c
 
#define ALT_I2C_SDA_HOLD_ADDR(base)   ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_I2C_SDA_HOLD_OFST))
 

Typedefs

typedef struct ALT_I2C_SDA_HOLD_s ALT_I2C_SDA_HOLD_t
 

Data Structure Documentation

struct ALT_I2C_SDA_HOLD_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_SDA_HOLD.

Data Fields
uint32_t ic_sda_hold: 16 SDA Hold Bit
uint32_t __pad0__: 16 UNDEFINED

Macro Definitions

#define ALT_I2C_SDA_HOLD_IC_SDA_HOLD_LSB   0

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

#define ALT_I2C_SDA_HOLD_IC_SDA_HOLD_MSB   15

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

#define ALT_I2C_SDA_HOLD_IC_SDA_HOLD_WIDTH   16

The width in bits of the ALT_I2C_SDA_HOLD_IC_SDA_HOLD register field.

#define ALT_I2C_SDA_HOLD_IC_SDA_HOLD_SET_MSK   0x0000ffff

The mask used to set the ALT_I2C_SDA_HOLD_IC_SDA_HOLD register field value.

#define ALT_I2C_SDA_HOLD_IC_SDA_HOLD_CLR_MSK   0xffff0000

The mask used to clear the ALT_I2C_SDA_HOLD_IC_SDA_HOLD register field value.

#define ALT_I2C_SDA_HOLD_IC_SDA_HOLD_RESET   0x1

The reset value of the ALT_I2C_SDA_HOLD_IC_SDA_HOLD register field.

#define ALT_I2C_SDA_HOLD_IC_SDA_HOLD_GET (   value)    (((value) & 0x0000ffff) >> 0)

Extracts the ALT_I2C_SDA_HOLD_IC_SDA_HOLD field value from a register.

#define ALT_I2C_SDA_HOLD_IC_SDA_HOLD_SET (   value)    (((value) << 0) & 0x0000ffff)

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

#define ALT_I2C_SDA_HOLD_OFST   0x7c

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

#define ALT_I2C_SDA_HOLD_ADDR (   base)    ALT_CAST(void *, (ALT_CAST(char *, (base)) + ALT_I2C_SDA_HOLD_OFST))

The address of the ALT_I2C_SDA_HOLD register.

Typedef Documentation

The typedef declaration for register ALT_I2C_SDA_HOLD.