Добавил:
Upload Опубликованный материал нарушает ваши авторские права? Сообщите нам.
Вуз: Предмет: Файл:
cubexHal.pdf
Скачиваний:
110
Добавлен:
10.02.2016
Размер:
16.16 Mб
Скачать

HAL SMARTCARD Generic Driver

 

UM1725

Function Name

HAL_SMARTCARD_StateTypeDef

 

HAL_SMARTCARD_GetState (SMARTCARD_HandleTypeDef *

 

hsc)

 

Function Description

return the SMARTCARD state

Parameters

 

hsc: pointer to a SMARTCARD_HandleTypeDef structure

 

 

that contains the configuration information for SMARTCARD

 

 

module.

Return values

 

HAL state

54.2.21HAL_SMARTCARD_GetError

Function Name

uint32_t HAL_SMARTCARD_GetError

 

(SMARTCARD_HandleTypeDef * hsc)

Function Description

Return the SMARTCARD error code.

Parameters

 

hsc: : pointer to a SMARTCARD_HandleTypeDef structure

 

 

that contains the configuration information for the specified

 

 

SMARTCARD.

Return values

 

SMARTCARD Error Code

54.3SMARTCARD Firmware driver defines

54.3.1SMARTCARD

SMARTCARD Clock Phase

SMARTCARD_PHASE_1EDGE

SMARTCARD_PHASE_2EDGE

SMARTCARD Clock Polarity

SMARTCARD_POLARITY_LOW

SMARTCARD_POLARITY_HIGH

SMARTCARD Error Code

 

HAL_SMARTCARD_ERROR_NONE

No error

 

HAL_SMARTCARD_ERROR_PE

Parity error

 

HAL_SMARTCARD_ERROR_NE

Noise error

 

HAL_SMARTCARD_ERROR_FE

Frame error

 

HAL_SMARTCARD_ERROR_ORE

Overrun error

 

HAL_SMARTCARD_ERROR_DMA

DMA transfer error

 

SMARTCARD Exported Macros

 

 

__HAL_SMARTCARD_RESET_HANDLE_STA Description:

 

TE

Reset SMARTCARD handle state.

 

 

 

 

Parameters:

 

 

__HANDLE__: specifies the

 

 

SMARTCARD Handle.

732/900

DOCID025834 Rev 2

UM1725

 

HAL SMARTCARD Generic Driver

 

Return value:

 

 

None

__HAL_SMARTCARD_FLUSH_DRREGISTER

Description:

 

Flushs the Smartcard DR register.

 

Parameters:

 

 

__HANDLE__: specifies the

 

 

SMARTCARD Handle.

__HAL_SMARTCARD_GET_FLAG

Description:

 

Checks whether the specified

 

 

Smartcard flag is set or not.

 

Parameters:

 

 

__HANDLE__: specifies the

 

 

SMARTCARD Handle.

 

__FLAG__: specifies the flag to

 

 

check. This parameter can be one

 

 

of the following values:

 

 

SMARTCARD_FLAG_TXE:

 

 

Transmit data register empty

 

 

flag

 

 

SMARTCARD_FLAG_TC:

 

 

Transmission Complete flag

 

 

SMARTCARD_FLAG_RXNE:

 

 

Receive data register not

 

 

empty flag

 

 

SMARTCARD_FLAG_IDLE:

 

 

Idle Line detection flag

 

 

SMARTCARD_FLAG_ORE:

 

 

Overrun Error flag

 

 

SMARTCARD_FLAG_NE:

 

 

Noise Error flag

 

 

SMARTCARD_FLAG_FE:

 

 

Framing Error flag

 

 

SMARTCARD_FLAG_PE:

 

 

Parity Error flag

 

Return value:

 

The: new state of __FLAG__

 

 

(TRUE or FALSE).

__HAL_SMARTCARD_CLEAR_FLAG

Description:

 

Clears the specified Smartcard

 

 

pending flags.

 

Parameters:

 

 

__HANDLE__: specifies the

 

 

SMARTCARD Handle.

 

__FLAG__: specifies the flag to

 

 

check. This parameter can be any

 

 

combination of the following

 

 

values:

DOCID025834 Rev 2

 

733/900

HAL SMARTCARD Generic Driver

UM1725

 

SMARTCARD_FLAG_TC:

 

Transmission Complete flag.

 

SMARTCARD_FLAG_RXNE:

 

Receive data register not

 

empty flag.

 

 

Notes:

 

 

PE (Parity error), FE (Framing

 

 

 

error), NE (Noise error) and ORE

 

 

 

(Overrun error) flags are cleared

 

 

 

by software sequence: a read

 

 

 

operation to USART_SR register

 

 

 

followed by a read operation to

 

 

 

USART_DR register. RXNE flag

 

 

 

can be also cleared by a read to

 

 

 

the USART_DR register. TC flag

 

 

 

can be also cleared by software

 

 

 

sequence: a read operation to

 

 

 

USART_SR register followed by a

 

 

 

write operation to USART_DR

 

 

 

register. TXE flag is cleared only

 

 

 

by a write to the USART_DR

 

 

 

register.

 

__HAL_SMARTCARD_CLEAR_PEFLAG

Description:

 

 

Clear the SMARTCARD PE

 

 

 

pending flag.

 

 

Parameters:

 

 

 

__HANDLE__: specifies the

 

 

 

USART Handle. This parameter

 

 

 

can be USARTx where x: 1, 2, 3,

 

 

 

4, 5, 6, 7 or 8 to select the USART

 

 

 

or UART peripheral.

 

 

Return value:

 

 

 

None

 

__HAL_SMARTCARD_CLEAR_FEFLAG

Description:

 

 

Clear the SMARTCARD FE

 

 

 

pending flag.

 

 

Parameters:

 

 

 

__HANDLE__: specifies the

 

 

 

USART Handle. This parameter

 

 

 

can be USARTx where x: 1, 2, 3,

 

 

 

4, 5, 6, 7 or 8 to select the USART

 

 

 

or UART peripheral.

 

 

Return value:

 

 

 

None

 

__HAL_SMARTCARD_CLEAR_NEFLAG

Description:

 

 

Clear the SMARTCARD NE

734/900

DOCID025834 Rev 2

 

 

UM1725

 

HAL SMARTCARD Generic Driver

 

 

pending flag.

 

Parameters:

 

 

__HANDLE__: specifies the

 

 

USART Handle. This parameter

 

 

can be USARTx where x: 1, 2, 3,

 

 

4, 5, 6, 7 or 8 to select the USART

 

 

or UART peripheral.

 

Return value:

 

 

None

__HAL_SMARTCARD_CLEAR_OREFLAG

Description:

 

Clear the SMARTCARD ORE

 

 

pending flag.

 

Parameters:

 

 

__HANDLE__: specifies the

 

 

USART Handle. This parameter

 

 

can be USARTx where x: 1, 2, 3,

 

 

4, 5, 6, 7 or 8 to select the USART

 

 

or UART peripheral.

 

Return value:

 

 

None

__HAL_SMARTCARD_CLEAR_IDLEFLAG

Description:

 

Clear the SMARTCARD IDLE

 

 

pending flag.

 

Parameters:

 

 

__HANDLE__: specifies the

 

 

USART Handle. This parameter

 

 

can be USARTx where x: 1, 2, 3,

 

 

4, 5, 6, 7 or 8 to select the USART

 

 

or UART peripheral.

 

Return value:

 

 

None

__HAL_SMARTCARD_ENABLE_IT

Description:

 

Enables or disables the specified

 

 

SmartCard interrupts.

 

Parameters:

 

 

__HANDLE__: specifies the

 

 

SMARTCARD Handle.

 

 

__INTERRUPT__: specifies the

 

 

SMARTCARD interrupt source to

 

 

check. This parameter can be one

 

 

of the following values:

 

 

SMARTCARD_IT_TXE:

 

 

Transmit Data Register empty

 

 

interrupt

DOCID025834 Rev 2

 

735/900

HAL SMARTCARD Generic Driver

 

UM1725

 

 

SMARTCARD_IT_TC:

 

 

Transmission complete

 

 

interrupt

 

 

SMARTCARD_IT_RXNE:

 

 

Receive Data register not

 

 

empty interrupt

 

 

SMARTCARD_IT_IDLE: Idle

 

 

line detection interrupt

 

 

SMARTCARD_IT_PE: Parity

 

 

Error interrupt

 

 

SMARTCARD_IT_ERR: Error

 

 

interrupt(Frame error, noise

 

 

error, overrun error)

__HAL_SMARTCARD_DISABLE_IT

 

 

__HAL_SMARTCARD_GET_IT_SOURCE

Description:

 

Checks whether the specified

 

 

SmartCard interrupt has occurred

 

 

or not.

 

Parameters:

 

 

__HANDLE__: specifies the

 

 

SmartCard Handle.

 

 

__IT__: specifies the

 

 

SMARTCARD interrupt source to

 

 

check. This parameter can be one

of the following values:

SMARTCARD_IT_TXE: Transmit Data Register empty interrupt

SMARTCARD_IT_TC: Transmission complete interrupt

SMARTCARD_IT_RXNE: Receive Data register not empty interrupt

SMARTCARD_IT_IDLE: Idle line detection interrupt

SMARTCARD_IT_ERR: Error interrupt

SMARTCARD_IT_PE: Parity Error interrupt

Return value:

The: new state of __IT__ (TRUE or FALSE).

__HAL_SMARTCARD_ONE_BIT_SAMPLE_EN ABLE

Description:

Macro to enable the SMARTCARD's one bit sample method.

Parameters:

__HANDLE__: specifies the

736/900

DOCID025834 Rev 2

UM1725

HAL SMARTCARD Generic Driver

__HAL_SMARTCARD_ONE_BIT_SAMPLE_DI SABLE

SMARTCARD Handle.

Return value:

None

Description:

Macro to disable the SMARTCARD's one bit sample method.

Parameters:

__HANDLE__: specifies the SMARTCARD Handle.

 

Return value:

 

 

None

__HAL_SMARTCARD_ENABLE

Description:

 

Enable the USART associated to

 

 

the SMARTCARD Handle.

 

Parameters:

 

 

__HANDLE__: specifies the

 

 

SMARTCARD Handle.

 

 

SMARTCARD Handle selects the

 

 

USARTx peripheral (USART

 

 

availability and x value depending

 

 

on device).

 

Return value:

 

 

None

__HAL_SMARTCARD_DISABLE

Description:

 

Disable the USART associated to

 

 

the SMARTCARD Handle.

 

Parameters:

 

 

__HANDLE__: specifies the

 

 

SMARTCARD Handle.

 

 

SMARTCARD Handle selects the

 

 

USARTx peripheral (USART

 

 

availability and x value depending

 

 

on device).

 

Return value:

 

 

None

__HAL_SMARTCARD_DMA_REQUEST_ENAB LE

Description:

Macros to enable or disable the SmartCard DMA request.

Parameters:

__HANDLE__: specifies the SmartCard Handle.

DOCID025834 Rev 2

737/900

HAL SMARTCARD Generic Driver

UM1725

__HAL_SMARTCARD_DMA_REQUEST_DISA BLE

SMARTCARD Last Bit

SMARTCARD_LASTBIT_DISABLE

SMARTCARD_LASTBIT_ENABLE

SMARTCARD Mode

SMARTCARD_MODE_RX

SMARTCARD_MODE_TX

SMARTCARD_MODE_TX_RX

SMARTCARD Parity

SMARTCARD_PARITY_EVEN

SMARTCARD_PARITY_ODD

SMARTCARD Prescaler

SMARTCARD_PRESCALER_SYSCLK_DIV2 SMARTCARD_PRESCALER_SYSCLK_DIV4 SMARTCARD_PRESCALER_SYSCLK_DIV6 SMARTCARD_PRESCALER_SYSCLK_DIV8 SMARTCARD_PRESCALER_SYSCLK_DIV10 SMARTCARD_PRESCALER_SYSCLK_DIV12 SMARTCARD_PRESCALER_SYSCLK_DIV14 SMARTCARD_PRESCALER_SYSCLK_DIV16 SMARTCARD_PRESCALER_SYSCLK_DIV18 SMARTCARD_PRESCALER_SYSCLK_DIV20 SMARTCARD_PRESCALER_SYSCLK_DIV22 SMARTCARD_PRESCALER_SYSCLK_DIV24 SMARTCARD_PRESCALER_SYSCLK_DIV26 SMARTCARD_PRESCALER_SYSCLK_DIV28 SMARTCARD_PRESCALER_SYSCLK_DIV30 SMARTCARD_PRESCALER_SYSCLK_DIV32 SMARTCARD_PRESCALER_SYSCLK_DIV34

__REQUEST__: specifies the SmartCard DMA request. This parameter can be one of the following values:

SMARTCARD_DMAREQ_TX: SmartCard DMA transmit request

SMARTCARD_DMAREQ_RX : SmartCard DMA receive request

SYSCLK divided by 2

SYSCLK divided by 4

SYSCLK divided by 6

SYSCLK divided by 8

SYSCLK divided by 10

SYSCLK divided by 12

SYSCLK divided by 14

SYSCLK divided by 16

SYSCLK divided by 18

SYSCLK divided by 20

SYSCLK divided by 22

SYSCLK divided by 24

SYSCLK divided by 26

SYSCLK divided by 28

SYSCLK divided by 30

SYSCLK divided by 32

SYSCLK divided by 34

738/900

DOCID025834 Rev 2

UM1725

HAL SMARTCARD Generic Driver

SMARTCARD_PRESCALER_SYSCLK_DIV36

SYSCLK divided by 36

SMARTCARD_PRESCALER_SYSCLK_DIV38

SYSCLK divided by 38

SMARTCARD_PRESCALER_SYSCLK_DIV40

SYSCLK divided by 40

SMARTCARD_PRESCALER_SYSCLK_DIV42

SYSCLK divided by 42

SMARTCARD_PRESCALER_SYSCLK_DIV44

SYSCLK divided by 44

SMARTCARD_PRESCALER_SYSCLK_DIV46

SYSCLK divided by 46

SMARTCARD_PRESCALER_SYSCLK_DIV48

SYSCLK divided by 48

SMARTCARD_PRESCALER_SYSCLK_DIV50

SYSCLK divided by 50

SMARTCARD_PRESCALER_SYSCLK_DIV52

SYSCLK divided by 52

SMARTCARD_PRESCALER_SYSCLK_DIV54

SYSCLK divided by 54

SMARTCARD_PRESCALER_SYSCLK_DIV56

SYSCLK divided by 56

SMARTCARD_PRESCALER_SYSCLK_DIV58

SYSCLK divided by 58

SMARTCARD_PRESCALER_SYSCLK_DIV60

SYSCLK divided by 60

SMARTCARD_PRESCALER_SYSCLK_DIV62

SYSCLK divided by 62

SMARTCARD Private Constants

SMARTCARD_TIMEOUT_VALUE

SMARTCARD_IT_MASK

SMARTCARD_DIV

SMARTCARD_DIVMANT

SMARTCARD_DIVFRAQ

SMARTCARD_BRR

SMARTCARD_CR1_REG_INDEX

SMARTCARD_CR3_REG_INDEX

SMARTCARD Private Macros

IS_SMARTCARD_WORD_LENGTH

IS_SMARTCARD_STOPBITS

IS_SMARTCARD_PARITY

IS_SMARTCARD_MODE

IS_SMARTCARD_POLARITY

IS_SMARTCARD_PHASE

IS_SMARTCARD_LASTBIT

IS_SMARTCARD_NACK_STATE

IS_SMARTCARD_BAUDRATE

SMARTCARD Number of Stop Bits

SMARTCARD_STOPBITS_0_5

SMARTCARD_STOPBITS_1_5

SMARTCARD Word Length

DOCID025834 Rev 2

739/900

HAL SMARTCARD Generic Driver

UM1725

SMARTCARD_WORDLENGTH_9B

 

740/900

DOCID025834 Rev 2

Соседние файлы в предмете [НЕСОРТИРОВАННОЕ]