API Reference

Here is a list of all modules:

[detail level 123]

M-HAL	This section introduces MT3620 CM4 common driver, including terms and acronyms, software architecture, file naming convention, API naming convention
ADC	This section describes the programming interfaces of the Analog-to-Digital Converter (ADC) M-HAL driver, including terms and acronyms, supported features, software architecture, details on how to use this driver, ADC define, enums, functions, structures and typedef
Define	M-HAL ADC define list information, maximum channel number that ADC supports, ADC ring buffer size and error return value
Enum	M-HAL ADC enumeration define list information, including define of the ADC one shot or periodic mode enumeration, define of the ADC finite state machine sampling times enumeration, define of the ADC operation mode enumeration(FIFO or DMA mode), define of the ADC channel number enumeration, define of the ADC interrupt enable enumeration
Function	M-HAL ADC function list information, ADC hardware initializing and de-initializing, setting and getting ADC parameters set, enabling and disabling ADC hardware output, gets ADC sample data using FIFO mode, gets ADC sample data using DMA mode, enabling and disabling clock
Struct	M-HAL ADC structure list information, including ADC controller state machine related parameters, ADC DMA mode related parameters, ADC controller structure which used to store the hardware register base address, clock, Rx done callback API
Typedef	M-HAL ADC typedef define list information, including define of the ADC OS-HAL user's callback API typedef
DMA	This section introduces the Direct Memory Access (DMA) APIs including terms and acronyms, supported features, software architecture, details on how to use this driver, enums, structures and functions
Define	This section introduces the Macro definition which is used as DMA M-HAL's API error return type
Enum	This section describes the enumeration definition in DMA device driver
Function	This section provides DMA M-HAL APIs(defined as Common Interface) to fully control the MediaTek DMA HW
Struct	This section introduces the structure definition in DMA M-HAL
Typedef	This section introduces the typedef used by DMA M-HAL
EINT	This section introduces the External Interrupt Controller(EINT) APIs including terms and acronyms, supported features, software architecture details on how to use this driver, EINT function groups, enums and functions
Define	This section introduces the Macro definition which is used as EINT M-HAL's API error return type
Enum	This section introduces the enumerations that EINT M-HAL used
Function	This section provides Fixed APIs(defined as Common Interface) to fully control the MediaTek EINT HW
GPIO	This section introduces the General-Purpose Input-Output (GPIO) APIs including terms and acronyms, supported features, software architecture details on how to use this driver, GPIO groups, enums and functions
Define	This section introduces the Macro definition which is used as GPIO M-HAL's API error return type
Enum	This section introduces the enumerations that GPIO should configure when calling GPIO APIs
Function	This section provides Fixed APIs(defined as Common Interface) to fully control the MediaTek GPIO HW
Struct	This section introduces the structure used by GPIO OS-HAL/M-HAL/HDL
GPIOIF	This section introduces the General-Purpose Inputs-Outputs Interface (GPIOIF) APIs including terms and acronyms, supported features, software architecture details on how to use this driver, GPIOIF groups, enums and functions
Define	This section introduces the Macro definition
Enum	This section introduces the enumerations that GPIOIF should configure when calling GPIOIF APIs
Function	This section provides Fixed APIs(defined as Common Interface) to fully control the MediaTek GPIOIF HW
Struct	This section introduces the structure used by GPIOIF OS-HAL/M-HAL/HDL
GPT	These sections introduce the Generic Purpose Timer (GPT), including terms and acronyms, supported features
Define	This section introduces the macro definitions which are used by GPT M-HAL's APIs error return type
Enum	This section introduces the enumerations that GPT M-HAL used
Function	This section provides Fixed APIs(defined as Common Interface) to fully control the MediaTek GPT HW
Struct	This section introduces the structure used by GPT M-HAL used
I2C	This section introduces the Inter-Integrated Circuit (I2C) APIs including terms and acronyms, supported features, software architecture, details on how to use this driver, enums, structures and functions
Define	This section introduces the Macro definition that I2C OS-HAL/M-HAL/HDL used
Enum	This section introduces the enumerations that I2C should configure before performing transfer
Function	This section provides Fixed APIs(defined as Common Interface) to fully control the MediaTek I2C HW
Struct	This section introduces the structure that I2C OS-HAL/M-HAL/HDL used
Typedef	This section introduces the typedef that I2C M-HAL used
I2S	This section introduces the Integrated Interchip Sound (I2S) APIs including terms and acronyms, supported features, software architecture, details on how to use this driver, enums, structures and functions
Define	This section introduces the Macro definition which is used as I2S M-HAL's API error return type
Enum	This section introduces the enumerations that I2S should configure before performing transfer
Function	This section provides fixed APIs (defined as Common Interface) to fully control the MediaTek I2S HW
Struct	This section introduces the structure used by I2S OS-HAL/M-HAL/HDL
Typedef	This section introduces the typedef that I2S M-HAL used
MBOX	This section introduces the Mailbox (MBOX) APIs including terms and acronyms, supported features, software architecture, details on how to use this driver, enums, structures and functions
Define	This section introduces the Macro definition which are used as MBOX M-HAL's and OS-HAL's API error return type
Enum	This section introduces the enumerations that are used by MBOX OS-HAL/M-HAL and user application
Function	This section provides fixed APIs(defined as Common Interface) to fully control the MediaTek MBOX HW
Struct	This section introduces the structures that are used by MBOX OS-HAL/M-HAL and user application
PWM	This section introduces the Pulse-Width Modulation (PWM) APIs, including terms and acronyms, supported features, software architecture, details on how to use this driver, PWM defines, enums, functions and structures
Define	This section introduces the Macro definition which is used as PWM M-HAL's API error return type
Enum	M-HAL PWM enumeration value list information, including define of the PWM channel number enumeration and define of the PWM running status enumeration
Function	M-HAL PWM API list information, including PWM controller allocating and releasing, PWM hardware initializing and de-initializing, setting PWM frequency and duty cycle, enabling and disabling PWM hardware output, getting PWM frequency and duty cycle, getting the current status of PWM, enabling and disabling clock
Struct	M-HAL PWM structure list information, including PWM controller structure, which used to store PWM controller resource
SPIM	This section introduces the Serial Peripheral Interface Master (SPIM) APIs including terms and acronyms, supported features, software architecture, details on how to use this driver, enums, structures and functions
Define	This section introduces the Macro definition which is used as SPIM M-HAL's API error return type
Enum	This section introduces the enumerations that SPIM should configure before performing transfer
Function	This section provides Fixed APIs(defined as Common Interface) to fully control the MediaTek SPIM HW
Struct	This section introduces the structure that SPIM OS-HAL/M-HAL/HDL used
Typedef	This section introduces the typedef that SPIM M-HAL used
SPIS	This section introduces the Serial Peripheral Interface Slave (SPIS) APIs including terms and acronyms, supported features, software architecture, details on how to use this driver, enums, structures and functions
Define	This section introduces the Macro definitions that are used to combine H2DMB and error return type
Enum	This section introduces the enumerations that should be configured before performing transfer
Function	This section provides Fixed APIs(defined as Common Interface) to fully control the MediaTek SPIS HW
Struct	This section introduces the structure that SPIS OS-HAL/M-HAL/HDL used
Typedef	This section introduces the typedef that SPIS M-HAL used
UART	This section introduces the Universal Asynchronous Receiver/Transmitter (UART) APIs including terms and acronyms, supported features, software architecture, details on how to use this driver, enums, structures and functions
Define	This section introduces the Macro definition which is used by UART M-HAL
Enum	This section introduces the enumerations that UART should configure before transfer
Function	This section provides Fixed APIs(defined as Common Interface) to fully control the MediaTek UART HW
Struct	This section introduces the structure used by UART OS-HAL/M-HAL/HDL
Typedef	This section introduces the typedef that UART M-HAL used
WDT	These sections introduce the Watchdog Timer (WDT), including terms and acronyms, supported features
Define	This section introduces the macro definitions which are used by WDT M-HAL's APIs error return type
Function	This section provides Fixed APIs(defined as Common Interface) to fully control the MediaTek WDT HW
Struct	This section introduces the structure used by WDT M-HAL used
OS-HAL	This section introduces the terms and acronyms of MT3620 CM4 common driver
Adc	This section introduces the Analog-to-Digital Converter (ADC) APIs including terms and acronyms, supported features, details on how to use this driver, enums, structures and functions
Function	OS-HAL ADC function list information, including ADC hardware initializing and de-initializing, enabling and disabling ADC hardware output, gets ADC sample data using one shot mode
Dma	This section describes the programing api of DMA OS-HAL layer, including terms and acronyms, supported features, details on how to use this driver, enums and functions
Enum	This section describes the enumeration definitions in DMA driver OS-HAL layer
Function	This section provides DMA OS-HAL APIs to use DMA channel for data transfer
Struct	This section introduces the structure definition in DMA OS-HAL
Typedef	This section introduces the typedef used by DMA OS-HAL Layer
Eint	This section introduces the External Interrupt Controller(EINT) APIs including terms and acronyms, supported features, details on how to use this driver, enums, structures and functions
Enum	This section introduces the enumerations that EINT uses while set debounce time
Function	This section provides high level APIs to upper layer
Gpio	This section introduces the Inter-Integrated Circuit (GPIO) APIs including terms and acronyms, supported features, details on how to use this driver, enums and functions
Enum	This section introduces the enumerations that GPIO should configure when calling GPIO APIs
Function	This section provides high level APIs to upper layer
Gpioif	This section introduces the Inter-Integrated Circuit (GPIOIF) APIs including terms and acronyms, supported features, details on how to use this driver, enums and functions
Define	This section introduces the Macro definition
Enum	This section introduces the enumerations that GPIOIF should configure when calling GPIOIF APIs
Function	This section provides high level APIs to upper layer
Typedef	This section introduces the typedef that gpioif OS-HAL used
Gpt	This section introduces the Generic Purpose Timer (GPT), including terms and acronyms, supported features
Enum	This section introduces the enumerations that specify the timer ID (Follow mhal_gpt.h) of the current GPT device unit
Function	This section provides high level APIs to upper layer
Struct	This section introduces the definition of GPT user interrupt handle structure
I2c	This section introduces the Inter-Integrated Circuit (I2C) APIs including terms and acronyms, supported features, details on how to use this driver, enums and functions
Enum	This section introduces the enumerations that I2C uses while performing transfer
Function	This section provides high level APIs to upper layer
I2s	This section introduces the Integrated Interchip Sound (I2S) APIs including terms and acronyms, supported features, software architecture, details on how to use this driver, enums, structures and functions
Enum	This section introduces the enumerations that I2S uses while performing transfer
Function	This section provides high level APIs to upper layer
Lp	This section introduces the Low Power (LP) APIs including terms and acronyms, supported features, software architecture, details on how to use this driver, enums, structures and functions
Enum	This section introduces the enumerations that LP should configure before entering LP
Function	This section provides Fixed APIs (defined as Common Interface) to fully support three low power scenarios of ARM Cortex-M4F I/O subsystems
Mbox	This section introduces the Mailbox (MBOX) APIs including terms and acronyms, supported features, details on how to use this driver, enums, structures and functions
Define	This section introduces the Macro definition which indicates the software interrupt amount of MBOX
Enum	This section introduces the enumerations that are used by MBOX OS-HAL and user application
Function	This section provides high level APIs to upper layer
Struct	This section introduces the structures that are used by MBOX OS-HAL and user application
Typedef	This section introduces the typedef that MBOX OS-HAL used
Pwm	This section introduces the Pulse-Width Modulation (PWM) APIs including terms and acronyms, supported features, details on how to use this driver, enums, structures and functions
Define	This section introduces the Macro definition which is used as PWM channel number
Enum	OS-HAL PWM enumeration value list information, including define of the PWM group number enumeration, the PWM channel number enumeration and define of the PWM running status enumeration
Function	OS-HAL PWM API list information, including PWM hardware initializing and de-initializing, setting PWM frequency and duty cycle, enabling and disabling PWM hardware output, feature enabling
Spim	This section introduces the Serial Peripheral Interface Master (SPIM) APIs including terms and acronyms, supported features, details on how to use this driver, enums, structures and functions
Enum	This section introduces the enumerations that SPIM uses while performing transfer
Function	This section provides high level APIs to upper layer
Typedef	This section introduces the typedef that SPIM OS-HAL used
Uart	This section introduces the Universal Asynchronous Receiver/Transmitter (UART) APIs including terms and acronyms, supported features, software architecture, details on how to use this driver, enums, structures and functions
Enum	This section introduces the enumerations used by UART OS-HAL used
Function	This section provides high level APIs to upper layer
Wdt	These sections introduce the Watchdog Timer (WDT) APIs including terms and acronyms, supported features, details on how to use this driver, enums, structures and functions
Enum	This section introduces the enumerations used by WDT OS-HAL used
Function	This section provides high level APIs to upper layer
Struct	This section introduces the structure used by WDT OS-HAL used