returnTypes.h File Reference

Standard return-value type used across all SPP modules. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Enumerations
enum	SPP_RetVal_t {   K_SPP_OK , K_SPP_ERROR , K_SPP_NOT_ENOUGH_PACKETS , K_SPP_NULL_PACKET ,   K_SPP_ERROR_ALREADY_INITIALIZED , K_SPP_ERROR_NULL_POINTER , K_SPP_ERROR_NOT_INITIALIZED , K_SPP_ERROR_INVALID_PARAMETER ,   K_SPP_ERROR_ON_SPI_TRANSACTION , K_SPP_ERROR_TIMEOUT , K_SPP_ERROR_NO_PORT , K_SPP_ERROR_REGISTRY_FULL }
	Unified return type for all SPP API functions. More...

Detailed Description

Standard return-value type used across all SPP modules.

Every public SPP function returns SPP_RetVal_t. Callers must check the return value; ignoring it is a programming error.

Naming conventions used in this file:

• Return-code values: SPP_* (no K_ prefix — cross-module, not hardware constants)
• Types: lowercase snake (foundation types shared with external components)

Definition in file returnTypes.h.

Enumeration Type Documentation

SPP_RetVal_t

enum SPP_RetVal_t

Unified return type for all SPP API functions.

Enumerator
K_SPP_OK	Operation completed successfully.
K_SPP_ERROR	Generic unspecified error.
K_SPP_NOT_ENOUGH_PACKETS	Packet pool exhausted.
K_SPP_NULL_PACKET	Packet pointer is NULL.
K_SPP_ERROR_ALREADY_INITIALIZED	Module already initialised; call ignored.
K_SPP_ERROR_NULL_POINTER	A required pointer argument is NULL.
K_SPP_ERROR_NOT_INITIALIZED	Module has not been initialised yet.
K_SPP_ERROR_INVALID_PARAMETER	An argument value is out of range.
K_SPP_ERROR_ON_SPI_TRANSACTION	SPI transaction failed.
K_SPP_ERROR_TIMEOUT	Operation timed out.
K_SPP_ERROR_NO_PORT	No OSAL/HAL port has been registered.
K_SPP_ERROR_REGISTRY_FULL	Service registry is full.

Definition at line 23 of file returnTypes.h.