HAL Documentation¶

Documentation has been created using Doxygen and can be accessed via the following link: HAL DOC.

The documentation is divided into 4 parts. These are briefly introduced below and what they contain is also explained:

• Modules

  The modules section contains all the abstracted peripherals and functionalities of the MCU. In general, a module consists of the following content for private (static internal) or exported (global) use:

  • Types

    Types such as initialisation or module handlers and start with the <MODULE>_<Usage> to reference a C namespace.

  • Constants

    Constants like error codes or modes.

  • Macros

    Global macros in the HAL library usually start with ‘__’ and are mostly used to check the current state of a module.

  • Functions

    Exported functions from the HAL library have the same namespace to reference it to a defined module:

    HAL_<MODULE>_<Function>_<MODE>()
    

    Example

    HAL_GPIO_TogglePin() || HAL_UART_Receive_IT()
    

• Data Structures

  The Data Structures is a list of all exported types of a module. The Data Field subsection contains an alphabetical list of all members of the above data structures.

• Files

  The Files section lists all the header and source files that the HAL library includes. Allows you to view the entire contents of a specific header and source file.

• Globals

  In the Globals section, all exported types from the modules are sorted by type and listed in alphabetical order.