MBX driver APIs

MBX driver APIs. More...

Macros
#define	MBX_CR_ALL_INTERRUPTS_MASK

Enumerations
enum	mbx_bus_access_resp_t { no_bus_error_no_wait = 0 , generate_bus_error = 1 }
enum	{ status_mbx_not_available = ((uint32_t)( status_group_mbx )*1000U + (uint32_t)( 2 )) }

Functions
static void	mbx_set_bus_access_response (MBX_Type *ptr, mbx_bus_access_resp_t resp)
	Set bus access response. More...
static void	mbx_enable_intr (MBX_Type *ptr, uint32_t mask)
	Enable interrupt with mask. More...
static void	mbx_disable_intr (MBX_Type *ptr, uint32_t mask)
	Disable interrupt with mask. More...
static void	mbx_empty_txfifo (MBX_Type *ptr)
	Empty fifo. More...
static void	mbx_init (MBX_Type *ptr)
	Initialization. More...
static hpm_stat_t	mbx_send_message (MBX_Type *ptr, uint32_t msg)
	Send message. More...
static hpm_stat_t	mbx_retrieve_message (MBX_Type *ptr, uint32_t *msg)
	Retrieve message. More...
static hpm_stat_t	mbx_send_fifo (MBX_Type *ptr, uint32_t *msg, uint32_t count)
	Send message to fifo. More...
static hpm_stat_t	mbx_retrieve_fifo (MBX_Type *ptr, uint32_t *msg, uint32_t count)
	Retrieve data from fifo. More...

Detailed Description

MBX driver APIs.

Macro Definition Documentation

MBX_CR_ALL_INTERRUPTS_MASK

#define MBX_CR_ALL_INTERRUPTS_MASK

#include <drivers/inc/hpm_mbx_drv.h>

Value:

        (MBX_CR_TFMAIE_MASK | MBX_CR_RFMAIE_MASK \
        | MBX_CR_RFMFIE_MASK | MBX_CR_TWMEIE_MASK)

Enumeration Type Documentation

anonymous enum

anonymous enum

#include <drivers/inc/hpm_mbx_drv.h>

Enumerator
status_mbx_not_available

mbx_bus_access_resp_t

enum mbx_bus_access_resp_t

#include <drivers/inc/hpm_mbx_drv.h>

Enumerator
no_bus_error_no_wait
generate_bus_error

Function Documentation

mbx_disable_intr()

static void mbx_disable_intr ( MBX_Type *  ptr, uint32_t  mask  )

inlinestatic

#include <drivers/inc/hpm_mbx_drv.h>

Disable interrupt with mask.

Parameters

[in]	ptr	MBX base address
[in]	mask	Mask of interrupts to be disabled

mbx_empty_txfifo()

static void mbx_empty_txfifo ( MBX_Type *  ptr )

inlinestatic

#include <drivers/inc/hpm_mbx_drv.h>

Empty fifo.

Parameters

[in]

ptr

MBX base address

mbx_enable_intr()

static void mbx_enable_intr ( MBX_Type *  ptr, uint32_t  mask  )

inlinestatic

#include <drivers/inc/hpm_mbx_drv.h>

Enable interrupt with mask.

Parameters

[in]	ptr	MBX base address
[in]	mask	Mask of interrupts to be enabled

mbx_init()

static void mbx_init ( MBX_Type *  ptr )

inlinestatic

#include <drivers/inc/hpm_mbx_drv.h>

Initialization.

Parameters

[in]

ptr

MBX base address

mbx_retrieve_fifo()

static hpm_stat_t mbx_retrieve_fifo ( MBX_Type *  ptr, uint32_t *  msg, uint32_t  count  )

inlinestatic

#include <drivers/inc/hpm_mbx_drv.h>

Retrieve data from fifo.

Parameters

[in]	ptr	MBX base address
[out]	msg	Pointer of buffer to receive data
[in]	count	Number of 32-bit data to be retrieved

Returns

status_success if everything is okay

status_mbx_not_available if fifo is empty

mbx_retrieve_message()

static hpm_stat_t mbx_retrieve_message ( MBX_Type *  ptr, uint32_t *  msg  )

inlinestatic

#include <drivers/inc/hpm_mbx_drv.h>

Retrieve message.

Parameters

[in]	ptr	MBX base address
[out]	msg	Pointer to buffer to save message data

Returns

status_success if everything is okay

mbx_send_fifo()

static hpm_stat_t mbx_send_fifo ( MBX_Type *  ptr, uint32_t *  msg, uint32_t  count  )

inlinestatic

#include <drivers/inc/hpm_mbx_drv.h>

Send message to fifo.

Parameters

[in]	ptr	MBX base address
[in]	msg	Pointer to message array to be sent
[in]	count	Number of 32-bit data to be sent

Returns

status_success if everything is okay

status_not_available if fifo is full

mbx_send_message()

static hpm_stat_t mbx_send_message ( MBX_Type *  ptr, uint32_t  msg  )

inlinestatic

#include <drivers/inc/hpm_mbx_drv.h>

Send message.

Parameters

[in]	ptr	MBX base address
[in]	msg	Message data in 32 bits

Returns

status_success if everything is okay

mbx_set_bus_access_response()

static void mbx_set_bus_access_response ( MBX_Type *  ptr, mbx_bus_access_resp_t  resp  )

inlinestatic

#include <drivers/inc/hpm_mbx_drv.h>

Set bus access response.

Parameters

[in]	ptr	MBX base address
[in]	resp	response value type