PDK API Guide for AM64x
MAILBOX_DRIVER_ERROR_CODE

Introduction

Macros

#define MAILBOX_ERRNO_BASE   (-2100)
 Mailbox driver error base. More...
 
#define MAILBOX_SOK   (0)
 Error Code: Invalid argument. More...
 
#define MAILBOX_EINVAL   (MAILBOX_ERRNO_BASE-1)
 Error Code: Invalid argument. More...
 
#define MAILBOX_EINUSE   (MAILBOX_ERRNO_BASE-2)
 Error Code: Operation cannot be implemented because a previous operation is still not complete. More...
 
#define MAILBOX_ENOMEM   (MAILBOX_ERRNO_BASE-3)
 Error Code: Out of memory. More...
 
#define MAILBOX_EINVALCFG   (MAILBOX_ERRNO_BASE-4)
 Error Code: Invalid configuration. More...
 
#define MAILBOX_ETXFULL   (MAILBOX_ERRNO_BASE-5)
 Error Code: TX mailbox full. Application tried to send a message before ACK of the previously TX message was received. More...
 
#define MAILBOX_ETXACKTIMEDOUT   (MAILBOX_ERRNO_BASE-6)
 Error Code: Write Acknowledge timed out. Driver was pending on semaphore waiting for an acknowledge and the semaphore timed out. More...
 
#define MAILBOX_EREADTIMEDOUT   (MAILBOX_ERRNO_BASE-7)
 Error Code: Blocking read timed out. More...
 
#define MAILBOX_EINITIALIZED   (MAILBOX_ERRNO_BASE-8)
 Error Code: Mailbox driver already initialized. More...
 
#define MAILBOX_EOSAL   (MAILBOX_ERRNO_BASE-9)
 Error Code: Osal call failed. More...
 
#define MAILBOX_EBADCHTYPE   (MAILBOX_ERRNO_BASE-10)
 Error Code: Invalid channel type. Indicates that the channel type is invalid, OR Indicates that a mailbox instance is tried to be opened with a channel type different than other instances (for the same endpoint). More...
 
#define MAILBOX_EBADCHID   (MAILBOX_ERRNO_BASE-11)
 Error Code: Invalid channel type. Indicates that the channel ID is invalid, OR Indicates that a channel ID is already in use. More...
 
#define MAILBOX_ECHINUSE   (MAILBOX_ERRNO_BASE-12)
 Error Code: Mailbox channel in use by another instance. More...
 
#define MAILBOX_ETIMEOUT   (MAILBOX_ERRNO_BASE-13)
 Error Code: Generic timeout from Driver pending on a semaphore. More...
 

Macro Definition Documentation

◆ MAILBOX_ERRNO_BASE

#define MAILBOX_ERRNO_BASE   (-2100)

Mailbox driver error base.

◆ MAILBOX_SOK

#define MAILBOX_SOK   (0)

Error Code: Invalid argument.

◆ MAILBOX_EINVAL

#define MAILBOX_EINVAL   (MAILBOX_ERRNO_BASE-1)

Error Code: Invalid argument.

◆ MAILBOX_EINUSE

#define MAILBOX_EINUSE   (MAILBOX_ERRNO_BASE-2)

Error Code: Operation cannot be implemented because a previous operation is still not complete.

◆ MAILBOX_ENOMEM

#define MAILBOX_ENOMEM   (MAILBOX_ERRNO_BASE-3)

Error Code: Out of memory.

◆ MAILBOX_EINVALCFG

#define MAILBOX_EINVALCFG   (MAILBOX_ERRNO_BASE-4)

Error Code: Invalid configuration.

◆ MAILBOX_ETXFULL

#define MAILBOX_ETXFULL   (MAILBOX_ERRNO_BASE-5)

Error Code: TX mailbox full. Application tried to send a message before ACK of the previously TX message was received.

This ACK is part of the mailbox peripheral protocol layer and is transparent to the application.

◆ MAILBOX_ETXACKTIMEDOUT

#define MAILBOX_ETXACKTIMEDOUT   (MAILBOX_ERRNO_BASE-6)

Error Code: Write Acknowledge timed out. Driver was pending on semaphore waiting for an acknowledge and the semaphore timed out.

◆ MAILBOX_EREADTIMEDOUT

#define MAILBOX_EREADTIMEDOUT   (MAILBOX_ERRNO_BASE-7)

Error Code: Blocking read timed out.

◆ MAILBOX_EINITIALIZED

#define MAILBOX_EINITIALIZED   (MAILBOX_ERRNO_BASE-8)

Error Code: Mailbox driver already initialized.

◆ MAILBOX_EOSAL

#define MAILBOX_EOSAL   (MAILBOX_ERRNO_BASE-9)

Error Code: Osal call failed.

◆ MAILBOX_EBADCHTYPE

#define MAILBOX_EBADCHTYPE   (MAILBOX_ERRNO_BASE-10)

Error Code: Invalid channel type. Indicates that the channel type is invalid, OR Indicates that a mailbox instance is tried to be opened with a channel type different than other instances (for the same endpoint).

◆ MAILBOX_EBADCHID

#define MAILBOX_EBADCHID   (MAILBOX_ERRNO_BASE-11)

Error Code: Invalid channel type. Indicates that the channel ID is invalid, OR Indicates that a channel ID is already in use.

◆ MAILBOX_ECHINUSE

#define MAILBOX_ECHINUSE   (MAILBOX_ERRNO_BASE-12)

Error Code: Mailbox channel in use by another instance.

◆ MAILBOX_ETIMEOUT

#define MAILBOX_ETIMEOUT   (MAILBOX_ERRNO_BASE-13)

Error Code: Generic timeout from Driver pending on a semaphore.