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. More...

Overview

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.

Terms and Acronyms

Terms	Details
FIFO	First In, First Out.
MBOX	Mailbox.

Supported Features

The MBOX supports FIFO/FIFO interrupt/Software interrupt/Semaphore.
For more details, please refer to MBOX datasheet.

How to use this driver

• SW Architecture:
  Refer to Overview of M-HAL SW Architecture for details of the SW architecture.

  This section describes the definition of APIs and provides an example of how to use these APIs to develop an OS-related MBOX driver on FreeRTOS.
  This section also provides an example of the sequence of APIs that should be used by the user application.

• The OS-HAL FreeRTOS driver sample code is as follows:
  FreeRTOS MBOX sample code on github

Modules
	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.