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

Overview

This section introduces the Mailbox (MBOX) APIs including terms and acronyms, supported features, 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

See Supported Features for the details of Supported Features.

How to use this driver

• Device driver sample code is as follows:
  
  • sample code (this is the user application sample code on FreeRTOS):

    - Open MBOX channel
     -Call mtk_os_hal_mbox_open_channel(mbox_channel_t channel)
       to open MBOX channel.
    
    - Register sw interrupt callback
      -Call mtk_os_hal_mbox_sw_int_register_cb(mbox_channel_t channel,
           mtk_os_hal_mbox_cb cb, u32 irq_status)
    
    - Register FIFO interrupt callback
      -Call mtk_os_hal_mbox_fifo_register_cb(mbox_channel_t channel,
           mtk_os_hal_mbox_cb cb, struct mbox_fifo_event *mask)
    
    - Getting/setting MBOX hardware settings
      -Call mtk_os_hal_mbox_ioctl(mbox_channel_t channel, mbox_ioctl_t ctrl,
           void *arg)
    
    - Write FIFO
     -Call  mtk_os_hal_mbox_fifo_write(mbox_channel_t channel,
       const struct mbox_fifo_item *buf, mbox_tr_type_t type)
    
    - Read FIFO
     -Call  mtk_os_hal_mbox_fifo_read(mbox_channel_t channel,
       const struct mbox_fifo_item *buf, mbox_tr_type_t type)
    
    - Unregister sw interrupt callback
      -Call mtk_os_hal_mbox_sw_int_unregister_cb(mbox_channel_t channel)
    
    - Unregister FIFO interrupt callback
      -Call mtk_os_hal_mbox_fifo_unregister_cb(mbox_channel_t channel)
    
    - Close MBOX channel
     -Call mtk_os_hal_mbox_close_channel(mbox_channel_t channel)
       to close MBOX channel.

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