AN3108 datasheet(33/44 Pages) STMICROELECTRONICS

33 / 44 page

AN3108

STLM75 library firmware

Doc ID 16793 Rev 1

33/44

TS_CheckEventWithTimeout HAL function

Table 23 describes the TS_CheckEventWithTimeout function of the hardware abstraction

layer.

TS_FillDataFromRegister HAL function

Table 24 describes the TS_FillDataFromRegister function of the hardware abstraction layer.

Table 23.

TS_CheckEventWithTimeout

Name

Description

Function name

TS_CheckEventWithTimeout

Function prototype

TS_ErrStatus TS_CheckEventWithTimeout(TS_I2C_SettingsType*

pI2C_Settings, u32 I2C_EVENT, u32 uTimeoutTicks)

Behavior description

Check the I2C event inside a max timeout time. This function requires that

the g_TempSensorTick variable is defined as extern in the main

application, and it is incremented in SysTickHandler Interrupt or another

scheduler time.

Input parameter {x}

pI2C_Settings - I2C peripheral settings structure pointer;

I2C_EVENT - The I2C event to check;

uTimeoutTicks - The g_TempSensorTick to wait before return an error;

uTimeoutTicks must be >=1.

Output parameter {x}

None

Return value

TS_OK if event occurs inside the timeout time, TS_ERROR otherwise

Required preconditions

g_TempSensorTick variable is defined as extern in the main application,

and it is incremented in a scheduler time.

Called functions

None

Table 24.

TS_FillDataFromRegister

Name

Description

Function name

TS_FillDataFromRegister

Function prototype

TS_ErrStatus TS_FillDataFromRegister(TS_I2C_SettingsType*

pI2C_Settings,TS_u16* pReadRegValue,

TS_RegLengthType eRegLenType, u32 uTimeoutTicks)

Behavior description

Read from the specified STLM75 a register value (8 or 16 bits) and return

the value in output parameter.

Warning:

SetPointerRegister function MUST be

called before calling this one.

Input parameter {x}

pI2C_Settings - I2C peripheral settings structure pointer;

eRegLenType - Register byte-length type (Can be 1-Byt or 2-Byte);

uTimeoutTicks - The g_TempSensorTick to wait before returning an error;

uTimeoutTicks must be >=1.

AN3108 Datasheet(PDF) 33 Page - STMicroelectronics

AN3108 Datasheet(HTML) 33 Page - STMicroelectronics

Html Pages

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

Datasheet Download

Link URL