HAL JPEG Overview ¶
Introducing JPEG ¶
- group JPEG_Introduction
-
-
This introduction is under development.
-
Module and files ¶
The following diagram illustrates the JPEG module and its associated files.
Component diagram ¶
The following diagram illustrates the software components involved in the JPEG module. It shows the interactions between the user application, HAL drivers, low-level drivers, and the hardware components.
![@startuml
<style>
componentDiagram {
arrow {
FontSize 8
}
}
</style>
title JPEG Software Component Diagram
package "HAL" {
[HAL_SERVICE]
[HAL_JPEG]
[HAL_RCC]
}
package "Low Layer" {
[CMSIS]
[JPEG Interrupt routine service]
}
package "HW" {
[STM32_HW]
}
[Appli] --> [HAL_JPEG] : HAL JPEG API
[Appli] <-- [HAL_JPEG] : JPEG callback
[HAL_JPEG] --> [CMSIS] : JPEG register def
[HAL_JPEG] -l-> [HAL_SERVICE] : HAL_GetTick
[HAL_JPEG] .r.> [HAL_RCC] : HAL_RCC_JPEG_EnableClock
[CMSIS] --> [STM32_HW] : JPEG registers R/W
[STM32_HW] --> [JPEG Interrupt routine service] :JPEG Irq
[HAL_JPEG] <-- [JPEG Interrupt routine service]
@enduml](../../../../_images/plantuml-f46b735eb194d797ad575bc9f359a0dd1e5ef34f.png)
Configuration table ¶
The following table lists the configuration defines for the HAL JPEG module, specifying their locations, default values, and descriptions:
- group JPEG_Configuration_Table
-
¶
Configuration inside the JPEG driver ¶
Config defines
Description
Default value
Note
PRODUCT
from IDE
None
The selected device.
USE_HAL_JPEG_MODULE
from hal_conf.h
1U
Allows to use HAL JPEG module.
USE_ASSERT_DBG_PARAM
from IDE
None
Allows to use the assert check parameters.
USE_ASSERT_DBG_STATE
from IDE
None
Allows to use the assert check states.
USE_HAL_CHECK_PARAM
from hal_conf.h
0
Allows to use the run-time checks parameters.
USE_HAL_JPEG_DMA
from hal_conf.h
0
Allows to use DMA mode.
USE_HAL_JPEG_REGISTER_CALLBACKS
from hal_conf.h
0
Allows to use register callbacks.
USE_HAL_JPEG_CLK_ENABLE_MODEL
from hal_conf.h
HAL_CLK_ENABLE_NO
Allows to use the clock enable model.
USE_HAL_JPEG_GET_LAST_ERRORS
from hal_conf.h
0
Allows to use error code mechanism.