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

Description

Timeout Register

Register Layout

Bits Access Reset Description
[7:0] RW 0x40 ALT_SDMMC_TMOUT_RESPONSE_TMO
[31:8] RW 0xffffff ALT_SDMMC_TMOUT_DATA_TMO

Field : response_timeout

Response timeout value.

Value is in number of card output clocks cclk_out.

Field Access Macros:

#define ALT_SDMMC_TMOUT_RESPONSE_TMO_LSB   0
 
#define ALT_SDMMC_TMOUT_RESPONSE_TMO_MSB   7
 
#define ALT_SDMMC_TMOUT_RESPONSE_TMO_WIDTH   8
 
#define ALT_SDMMC_TMOUT_RESPONSE_TMO_SET_MSK   0x000000ff
 
#define ALT_SDMMC_TMOUT_RESPONSE_TMO_CLR_MSK   0xffffff00
 
#define ALT_SDMMC_TMOUT_RESPONSE_TMO_RESET   0x40
 
#define ALT_SDMMC_TMOUT_RESPONSE_TMO_GET(value)   (((value) & 0x000000ff) >> 0)
 
#define ALT_SDMMC_TMOUT_RESPONSE_TMO_SET(value)   (((value) << 0) & 0x000000ff)
 

Field : data_timeout

Value for card Data Read Timeout; same value also used for Data

Starvation by Host timeout. The timeout counter is started only after the card clock is stopped.Value is in number of card output clocks cclk_out of selected card.

Note: The software timer should be used if the timeout value is in the order

of 100 ms. In this case, read data timeout interrupt needs to be disabled.

Field Access Macros:

#define ALT_SDMMC_TMOUT_DATA_TMO_LSB   8
 
#define ALT_SDMMC_TMOUT_DATA_TMO_MSB   31
 
#define ALT_SDMMC_TMOUT_DATA_TMO_WIDTH   24
 
#define ALT_SDMMC_TMOUT_DATA_TMO_SET_MSK   0xffffff00
 
#define ALT_SDMMC_TMOUT_DATA_TMO_CLR_MSK   0x000000ff
 
#define ALT_SDMMC_TMOUT_DATA_TMO_RESET   0xffffff
 
#define ALT_SDMMC_TMOUT_DATA_TMO_GET(value)   (((value) & 0xffffff00) >> 8)
 
#define ALT_SDMMC_TMOUT_DATA_TMO_SET(value)   (((value) << 8) & 0xffffff00)
 

Data Structures

struct  ALT_SDMMC_TMOUT_s
 

Macros

#define ALT_SDMMC_TMOUT_RESET   0xffffff40
 
#define ALT_SDMMC_TMOUT_OFST   0x14
 

Typedefs

typedef struct ALT_SDMMC_TMOUT_s ALT_SDMMC_TMOUT_t
 

Data Structure Documentation

struct ALT_SDMMC_TMOUT_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_SDMMC_TMOUT.

Data Fields
uint32_t response_timeout: 8 ALT_SDMMC_TMOUT_RESPONSE_TMO
uint32_t data_timeout: 24 ALT_SDMMC_TMOUT_DATA_TMO

Macro Definitions

#define ALT_SDMMC_TMOUT_RESPONSE_TMO_LSB   0

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

#define ALT_SDMMC_TMOUT_RESPONSE_TMO_MSB   7

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

#define ALT_SDMMC_TMOUT_RESPONSE_TMO_WIDTH   8

The width in bits of the ALT_SDMMC_TMOUT_RESPONSE_TMO register field.

#define ALT_SDMMC_TMOUT_RESPONSE_TMO_SET_MSK   0x000000ff

The mask used to set the ALT_SDMMC_TMOUT_RESPONSE_TMO register field value.

#define ALT_SDMMC_TMOUT_RESPONSE_TMO_CLR_MSK   0xffffff00

The mask used to clear the ALT_SDMMC_TMOUT_RESPONSE_TMO register field value.

#define ALT_SDMMC_TMOUT_RESPONSE_TMO_RESET   0x40

The reset value of the ALT_SDMMC_TMOUT_RESPONSE_TMO register field.

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

Extracts the ALT_SDMMC_TMOUT_RESPONSE_TMO field value from a register.

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

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

#define ALT_SDMMC_TMOUT_DATA_TMO_LSB   8

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

#define ALT_SDMMC_TMOUT_DATA_TMO_MSB   31

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

#define ALT_SDMMC_TMOUT_DATA_TMO_WIDTH   24

The width in bits of the ALT_SDMMC_TMOUT_DATA_TMO register field.

#define ALT_SDMMC_TMOUT_DATA_TMO_SET_MSK   0xffffff00

The mask used to set the ALT_SDMMC_TMOUT_DATA_TMO register field value.

#define ALT_SDMMC_TMOUT_DATA_TMO_CLR_MSK   0x000000ff

The mask used to clear the ALT_SDMMC_TMOUT_DATA_TMO register field value.

#define ALT_SDMMC_TMOUT_DATA_TMO_RESET   0xffffff

The reset value of the ALT_SDMMC_TMOUT_DATA_TMO register field.

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

Extracts the ALT_SDMMC_TMOUT_DATA_TMO field value from a register.

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

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

#define ALT_SDMMC_TMOUT_RESET   0xffffff40

The reset value of the ALT_SDMMC_TMOUT register.

#define ALT_SDMMC_TMOUT_OFST   0x14

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

Typedef Documentation

The typedef declaration for register ALT_SDMMC_TMOUT.