modm_data.cubehal

STMicro STM32CubeHAL Source Code

The STM32CubeHAL source code provides useful information:

  • Determine canonical names of conflicting data items.
  • Determine the map of register bit field values to names.
 1# Copyright 2022, Niklas Hauser
 2# SPDX-License-Identifier: MPL-2.0
 3
 4"""
 5# STMicro STM32CubeHAL Source Code
 6
 7The STM32CubeHAL source code provides useful information:
 8
 9- Determine canonical names of conflicting data items.
10- Determine the map of register bit field values to names.
11"""
12
13from .dmamux_requests import read_request_map
14
15__all__ = ["read_request_map"]
def read_request_map(did: modm_data.owl.DeviceIdentifier) -> dict[str, int]: 
15def read_request_map(did: DeviceIdentifier) -> dict[str, int]:
16    """
17    Reads the DMA requests mapping from the Low-Level (LL) CubeHAL header files.
18
19    :param did: Device to query for.
20    :return: A dictionary of DMA trigger name to trigger position.
21    """
22    dma_header = _get_hal_dma_header_path(did.family)
23    dmamux_header = _get_ll_dmamux_header_path(did.family)
24    request_map = None
25    if did.family in ["g4", "h7", "l5"]:
26        request_map = _read_requests(dma_header)
27    elif did.family in ["g0", "wb", "wl"]:
28        request_map = _read_requests_from_ll_dmamux(dma_header, dmamux_header)
29    elif did.family == "l4" and did.name[0] in ["p", "q", "r", "s"]:
30        request_map = _read_requests_l4(did.name in ["p5", "q5"])
31    else:
32        raise RuntimeError(f"No DMAMUX request data available for {did}")
33    _fix_request_data(request_map)
34    return request_map

Reads the DMA requests mapping from the Low-Level (LL) CubeHAL header files.

Parameters
  • did: Device to query for.
Returns

A dictionary of DMA trigger name to trigger position.