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

UM1725

 

HAL IRDA Generic Driver

Function Name

void HAL_IRDA_MspInit (IRDA_HandleTypeDef * hirda)

Function Description

IRDA MSP Init.

Parameters

 

hirda: pointer to a IRDA_HandleTypeDef structure that

 

 

contains the configuration information for the specified IRDA

 

 

module.

Return values

 

None

34.2.8HAL_IRDA_MspDeInit

Function Name

void HAL_IRDA_MspDeInit (IRDA_HandleTypeDef * hirda)

Function Description

IRDA MSP DeInit.

Parameters

 

hirda: pointer to a IRDA_HandleTypeDef structure that

 

 

contains the configuration information for the specified IRDA

 

 

module.

Return values

 

None

34.2.9HAL_IRDA_Transmit

Function Name

HAL_StatusTypeDef HAL_IRDA_Transmit

 

(IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size,

 

uint32_t Timeout)

Function Description

Sends an amount of data in blocking mode.

Parameters

 

hirda: pointer to a IRDA_HandleTypeDef structure that

 

 

contains the configuration information for the specified IRDA

 

 

module.

 

 

pData: Pointer to data buffer

 

 

Size: Amount of data to be sent

 

 

Timeout: Specify timeout value

Return values

 

HAL status

34.2.10HAL_IRDA_Receive

Function Name

HAL_StatusTypeDef HAL_IRDA_Receive

 

(IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size,

 

uint32_t Timeout)

Function Description

Receive an amount of data in blocking mode.

Parameters

 

hirda: pointer to a IRDA_HandleTypeDef structure that

 

 

contains the configuration information for the specified IRDA

 

 

module.

 

 

pData: Pointer to data buffer

 

 

Size: Amount of data to be received

 

 

Timeout: Specify timeout value

Return values

 

HAL status

34.2.11HAL_IRDA_Transmit_IT

Function Name

HAL_StatusTypeDef HAL_IRDA_Transmit_IT

 

 

DOCID025834 Rev 2

441/900

HAL IRDA Generic Driver

 

UM1725

 

(IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size)

Function Description

Send an amount of data in non blocking mode.

Parameters

 

hirda: pointer to a IRDA_HandleTypeDef structure that

 

 

contains the configuration information for the specified IRDA

 

 

module.

 

pData: Pointer to data buffer

 

Size: Amount of data to be sent

Return values

 

HAL status

34.2.12HAL_IRDA_Receive_IT

Function Name

HAL_StatusTypeDef HAL_IRDA_Receive_IT

 

(IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size)

Function Description

Receives an amount of data in non blocking mode.

Parameters

 

hirda: pointer to a IRDA_HandleTypeDef structure that

 

 

contains the configuration information for the specified IRDA

 

 

module.

 

 

pData: Pointer to data buffer

 

 

Size: Amount of data to be received

Return values

 

HAL status

34.2.13HAL_IRDA_Transmit_DMA

Function Name

HAL_StatusTypeDef HAL_IRDA_Transmit_DMA

 

(IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size)

Function Description

Sends an amount of data in non blocking mode.

Parameters

 

hirda: pointer to a IRDA_HandleTypeDef structure that

 

 

contains the configuration information for the specified IRDA

 

 

module.

 

 

pData: Pointer to data buffer

 

 

Size: Amount of data to be sent

Return values

 

HAL status

34.2.14HAL_IRDA_Receive_DMA

Function Name

HAL_StatusTypeDef HAL_IRDA_Receive_DMA

 

(IRDA_HandleTypeDef * hirda, uint8_t * pData, uint16_t Size)

Function Description

Receives an amount of data in non blocking mode.

Parameters

 

hirda: pointer to a IRDA_HandleTypeDef structure that

 

 

contains the configuration information for the specified IRDA

 

 

module.

 

pData: Pointer to data buffer

 

Size: Amount of data to be received

Return values

 

HAL status

Notes

When the IRDA parity is enabled (PCE = 1) the data received

 

 

contain the parity bit.

442/900

 

DOCID025834 Rev 2

UM1725

HAL IRDA Generic Driver

34.2.15HAL_IRDA_DMAPause

Function Name

HAL_StatusTypeDef HAL_IRDA_DMAPause

 

(IRDA_HandleTypeDef * hirda)

Function Description

Pauses the DMA Transfer.

Parameters

 

hirda: pointer to a IRDA_HandleTypeDef structure that

 

 

contains the configuration information for the specified IRDA

 

 

module.

Return values

 

HAL status

34.2.16HAL_IRDA_DMAResume

Function Name

HAL_StatusTypeDef HAL_IRDA_DMAResume

 

(IRDA_HandleTypeDef * hirda)

Function Description

Resumes the DMA Transfer.

Parameters

 

hirda: pointer to a IRDA_HandleTypeDef structure that

 

 

contains the configuration information for the specified UART

 

 

module.

Return values

 

HAL status

34.2.17HAL_IRDA_DMAStop

Function Name

HAL_StatusTypeDef HAL_IRDA_DMAStop

 

(IRDA_HandleTypeDef * hirda)

Function Description

Stops the DMA Transfer.

Parameters

 

hirda: pointer to a IRDA_HandleTypeDef structure that

 

 

contains the configuration information for the specified UART

 

 

module.

Return values

 

HAL status

34.2.18HAL_IRDA_IRQHandler

Function Name

void HAL_IRDA_IRQHandler (IRDA_HandleTypeDef * hirda)

Function Description

This function handles IRDA interrupt request.

Parameters

 

hirda: pointer to a IRDA_HandleTypeDef structure that

 

 

contains the configuration information for the specified IRDA

 

 

module.

Return values

 

None

34.2.19HAL_IRDA_TxCpltCallback

Function Name

void HAL_IRDA_TxCpltCallback (IRDA_HandleTypeDef *

 

hirda)

Function Description

Tx Transfer complete callbacks.

Parameters

 

hirda: pointer to a IRDA_HandleTypeDef structure that

contains the configuration information for the specified IRDA module.

DOCID025834 Rev 2

443/900

HAL IRDA Generic Driver

UM1725

Return values

None

34.2.20HAL_IRDA_TxHalfCpltCallback

Function Name

void HAL_IRDA_TxHalfCpltCallback (IRDA_HandleTypeDef *

 

hirda)

Function Description

Tx Half Transfer completed callbacks.

Parameters

 

hirda: pointer to a IRDA_HandleTypeDef structure that

 

 

contains the configuration information for the specified

 

 

USART module.

Return values

 

None

34.2.21HAL_IRDA_RxCpltCallback

Function Name

void HAL_IRDA_RxCpltCallback (IRDA_HandleTypeDef *

 

hirda)

Function Description

Rx Transfer complete callbacks.

Parameters

 

hirda: pointer to a IRDA_HandleTypeDef structure that

 

 

contains the configuration information for the specified IRDA

 

 

module.

Return values

 

None

34.2.22HAL_IRDA_RxHalfCpltCallback

Function Name

void HAL_IRDA_RxHalfCpltCallback (IRDA_HandleTypeDef *

 

hirda)

Function Description

Rx Half Transfer complete callbacks.

Parameters

 

hirda: pointer to a IRDA_HandleTypeDef structure that

 

 

contains the configuration information for the specified IRDA

 

 

module.

Return values

 

None

34.2.23HAL_IRDA_ErrorCallback

Function Name

void HAL_IRDA_ErrorCallback (IRDA_HandleTypeDef * hirda)

Function Description

IRDA error callbacks.

Parameters

 

hirda: pointer to a IRDA_HandleTypeDef structure that

 

 

contains the configuration information for the specified IRDA

 

 

module.

Return values

 

None

34.2.24HAL_IRDA_GetState

Function Name

HAL_IRDA_StateTypeDef HAL_IRDA_GetState

 

(IRDA_HandleTypeDef * hirda)

Function Description

Returns the IRDA state.

Parameters

hirda: pointer to a IRDA_HandleTypeDef structure that

444/900

DOCID025834 Rev 2

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