Azure Sphere MT3620 M4 API Reference Manual
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Enum

This section introduces the enumerations that are used by MBOX OS-HAL/M-HAL and user application. More...

Overview

This section introduces the enumerations that are used by MBOX OS-HAL/M-HAL and user application.

Typedefs

typedef enum mbox_transfer_type mbox_tr_type_t
 User should specify the transfer type when reading/writing FIFO. More...
 
typedef enum mbox_ioctl_type mbox_ioctl_t
 Users should specify the ioctl type when setting/getting information to/from MBOX HW.
 

Enumerations

enum  mbox_int_type {
  MBOX_INT_TYPE_NE,
  MBOX_INT_TYPE_WR,
  MBOX_INT_TYPE_NF,
  MBOX_INT_TYPE_RD,
  MBOX_INT_TYPE_MAX
}
 FIFO interrupt type. More...
 
enum  mbox_sem_status {
  MBOX_SEM_UNLOCK,
  MBOX_SEM_CM4_LOCK,
  MBOX_SEM_CA7_LOCK,
  MBOX_SEM_UNDEF
}
 Semaphore status, only used between CA7 and CM4. More...
 
enum  mbox_transfer_type {
  MBOX_TR_CMD_ONLY,
  MBOX_TR_DATA_CMD,
  MBOX_TR_MAX
}
 User should specify the transfer type when reading/writing FIFO. More...
 
enum  mbox_ioctl_type {
  MBOX_IOSET_NE_THRS,
  MBOX_IOGET_NE_THRS,
  MBOX_IOSET_NF_THRS,
  MBOX_IOGET_NF_THRS,
  MBOX_IOSET_SEM_POST,
  MBOX_IOSET_SEM_PEND,
  MBOX_IOSET_SWINT_TRIG,
  MBOX_IOSET_SWINT_EN,
  MBOX_IOGET_SWINT_EN,
  MBOX_IOSET_SWINT_CTRL,
  MBOX_IOGET_SWINT_STS,
  MBOX_IOSET_CLEAR_SWINT,
  MBOX_IOSET_INT_EN,
  MBOX_IOGET_INT_EN,
  MBOX_IOGET_INT_STS,
  MBOX_IOSET_CLEAR_INT,
  MBOX_IOGET_POST_FIFO_CNT,
  MBOX_IOGET_ACPT_FIFO_CNT
}
 Users should specify the ioctl type when setting/getting information to/from MBOX HW. More...
 

Typedef Documentation

User should specify the transfer type when reading/writing FIFO.

Enumeration Type Documentation

FIFO interrupt type.

Enumerator
MBOX_INT_TYPE_NE 

FIFO Non-Empty interrupt.

MBOX_INT_TYPE_WR 

FIFO Write interrupt.

MBOX_INT_TYPE_NF 

FIFO Non-Full interrupt.

MBOX_INT_TYPE_RD 

FIFO Read interrupt.

MBOX_INT_TYPE_MAX 

Invalid.

Semaphore status, only used between CA7 and CM4.

Enumerator
MBOX_SEM_UNLOCK 

SEM UNLOCK.

MBOX_SEM_CM4_LOCK 

SEM CM4 LOCK.

MBOX_SEM_CA7_LOCK 

SEM CA7 LOCK.

MBOX_SEM_UNDEF 

Invalid State.

User should specify the transfer type when reading/writing FIFO.

Enumerator
MBOX_TR_CMD_ONLY 

Only write/read cmd to/from FIFO.

MBOX_TR_DATA_CMD 

Write/read both data and cmd to/from FIFO.

MBOX_TR_MAX 

Meaningless transfer type.

Users should specify the ioctl type when setting/getting information to/from MBOX HW.

Enumerator
MBOX_IOSET_NE_THRS 

Set FIFO Non-Empty threshold.

MBOX_IOGET_NE_THRS 

Get FIFO Non-Empty threshold.

MBOX_IOSET_NF_THRS 

Set FIFO Non-Full threshold.

MBOX_IOGET_NF_THRS 

Get FIFO Non-Full threshold.

MBOX_IOSET_SEM_POST 

Release sema.

MBOX_IOSET_SEM_PEND 

Acquire sema.

MBOX_IOSET_SWINT_TRIG 

Trigger software interrupt.

MBOX_IOSET_SWINT_EN 

Enable software interrupt.

MBOX_IOGET_SWINT_EN 

Get 'enable software interrupt' mask.

MBOX_IOSET_SWINT_CTRL 

Control software interrupt.

MBOX_IOGET_SWINT_STS 

Get software interrupt status.

MBOX_IOSET_CLEAR_SWINT 

Clear software interrupt.

MBOX_IOSET_INT_EN 

Enable FIFO interrupt.

MBOX_IOGET_INT_EN 

Get 'enable FIFO interrupt' mask.

MBOX_IOGET_INT_STS 

Get FIFO interrupt status.

MBOX_IOSET_CLEAR_INT 

Clear FIFO interrupt.

MBOX_IOGET_POST_FIFO_CNT 

Get write FIFO count(CMD FIFO).

MBOX_IOGET_ACPT_FIFO_CNT 

Get read FIFO count(CMD FIFO).