TUKS MCU Introductory course / TUKS-COURSE-THERMOMETER

Fork of TUKS-COURSE-TIMER by TUKS MCU Introductory course

Embed: (wiki syntax)

« Back to documentation index

Input and Output operation functions

Input and Output operation functions
[CAN Exported Functions]

I/O operation functions. More...

Functions

HAL_StatusTypeDef HAL_CAN_Transmit (CAN_HandleTypeDef *hcan, uint32_t Timeout)
 Initiate and transmit a CAN frame message.
HAL_StatusTypeDef HAL_CAN_Transmit_IT (CAN_HandleTypeDef *hcan)
 Initiate and transmit a CAN frame message in Interrupt mode.
HAL_StatusTypeDef HAL_CAN_Receive (CAN_HandleTypeDef *hcan, uint8_t FIFONumber, uint32_t Timeout)
 Receive a correct CAN frame.
HAL_StatusTypeDef HAL_CAN_Receive_IT (CAN_HandleTypeDef *hcan, uint8_t FIFONumber)
 Receive a correct CAN frame in Interrupt mode.
HAL_StatusTypeDef HAL_CAN_Sleep (CAN_HandleTypeDef *hcan)
 Enter the Sleep (low power) mode.
HAL_StatusTypeDef HAL_CAN_WakeUp (CAN_HandleTypeDef *hcan)
 Wake up the CAN peripheral from sleep mode (after that the CAN peripheral is in the normal mode).
void HAL_CAN_IRQHandler (CAN_HandleTypeDef *hcan)
 Handle CAN interrupt request.
__weak void HAL_CAN_TxCpltCallback (CAN_HandleTypeDef *hcan)
 Transmission complete callback in non-blocking mode.
__weak void HAL_CAN_RxCpltCallback (CAN_HandleTypeDef *hcan)
 Reception complete callback in non-blocking mode.
__weak void HAL_CAN_ErrorCallback (CAN_HandleTypeDef *hcan)
 Error CAN callback.

Detailed Description

I/O operation functions.

  ==============================================================================
                      ##### IO operation functions #####
  ==============================================================================
    [..]  This section provides functions allowing to:
      (+) Transmit a CAN frame message.
      (+) Receive a CAN frame message.
      (+) Enter CAN peripheral in sleep mode. 
      (+) Wake up the CAN peripheral from sleep mode.
               

Function Documentation

__weak void HAL_CAN_ErrorCallback ( CAN_HandleTypeDef *  hcan )

Error CAN callback.

Parameters:
hcan,:pointer to a CAN_HandleTypeDef structure that contains the configuration information for the specified CAN.
Return values:
None

Definition at line 1200 of file stm32l4xx_hal_can.c.

void HAL_CAN_IRQHandler ( CAN_HandleTypeDef *  hcan )

Handle CAN interrupt request.

Parameters:
hcan,:pointer to a CAN_HandleTypeDef structure that contains the configuration information for the specified CAN.
Return values:
None

Definition at line 1051 of file stm32l4xx_hal_can.c.

HAL_StatusTypeDef HAL_CAN_Receive ( CAN_HandleTypeDef *  hcan,
uint8_t  FIFONumber,
uint32_t  Timeout 
)

Receive a correct CAN frame.

Parameters:
hcan,:pointer to a CAN_HandleTypeDef structure that contains the configuration information for the specified CAN.
FIFONumber,:FIFO number.
Timeout,:Timeout duration.
Return values:
HALstatus

Definition at line 775 of file stm32l4xx_hal_can.c.

HAL_StatusTypeDef HAL_CAN_Receive_IT ( CAN_HandleTypeDef *  hcan,
uint8_t  FIFONumber 
)

Receive a correct CAN frame in Interrupt mode.

Parameters:
hcan,:pointer to a CAN_HandleTypeDef structure that contains the configuration information for the specified CAN.
FIFONumber,:FIFO number.
Return values:
HALstatus

Definition at line 878 of file stm32l4xx_hal_can.c.

__weak void HAL_CAN_RxCpltCallback ( CAN_HandleTypeDef *  hcan )

Reception complete callback in non-blocking mode.

Parameters:
hcan,:pointer to a CAN_HandleTypeDef structure that contains the configuration information for the specified CAN.
Return values:
None

Definition at line 1184 of file stm32l4xx_hal_can.c.

HAL_StatusTypeDef HAL_CAN_Sleep ( CAN_HandleTypeDef *  hcan )

Enter the Sleep (low power) mode.

Parameters:
hcan,:pointer to a CAN_HandleTypeDef structure that contains the configuration information for the specified CAN.
Return values:
HALstatus.

Definition at line 944 of file stm32l4xx_hal_can.c.

HAL_StatusTypeDef HAL_CAN_Transmit ( CAN_HandleTypeDef *  hcan,
uint32_t  Timeout 
)

Initiate and transmit a CAN frame message.

Parameters:
hcan,:pointer to a CAN_HandleTypeDef structure that contains the configuration information for the specified CAN.
Timeout,:Timeout duration.
Return values:
HALstatus

Definition at line 536 of file stm32l4xx_hal_can.c.

HAL_StatusTypeDef HAL_CAN_Transmit_IT ( CAN_HandleTypeDef *  hcan )

Initiate and transmit a CAN frame message in Interrupt mode.

Parameters:
hcan,:pointer to a CAN_HandleTypeDef structure that contains the configuration information for the specified CAN.
Return values:
HALstatus

Definition at line 663 of file stm32l4xx_hal_can.c.

__weak void HAL_CAN_TxCpltCallback ( CAN_HandleTypeDef *  hcan )

Transmission complete callback in non-blocking mode.

Parameters:
hcan,:pointer to a CAN_HandleTypeDef structure that contains the configuration information for the specified CAN.
Return values:
None

Definition at line 1168 of file stm32l4xx_hal_can.c.

HAL_StatusTypeDef HAL_CAN_WakeUp ( CAN_HandleTypeDef *  hcan )

Wake up the CAN peripheral from sleep mode (after that the CAN peripheral is in the normal mode).

Parameters:
hcan,:pointer to a CAN_HandleTypeDef structure that contains the configuration information for the specified CAN.
Return values:
HALstatus.

Definition at line 999 of file stm32l4xx_hal_can.c.