Solaris Software
Loading...
Searching...
No Matches
spp.h
Go to the documentation of this file.
1/**
2 * @file spp.h
3 * @brief Top-level SPP include — pulls in the full public API.
4 *
5 * Include this single header to access all SPP functionality.
6 * Platform ports need to provide a @ref SPP_HalPort_t implementation
7 * registered before @ref SPP_CORE_init().
8 */
9
10#ifndef SPP_H
11#define SPP_H
12
13/* Core */
14#include "spp/core/version.h"
15#include "spp/core/types.h"
16#include "spp/core/returnTypes.h"
17#include "spp/core/packet.h"
18#include "spp/core/core.h"
19
20/* Port contracts */
21#include "spp/hal/hal.h"
22
23/* HAL dispatch API */
24#include "spp/hal/spi/spi.h"
25#include "spp/hal/uart/uart.h"
26#include "spp/hal/gpio/gpio.h"
27#include "spp/hal/storage/storage.h"
28#include "spp/hal/time/time.h"
29
30/* Services */
31#include "spp/services/service.h"
32#include "spp/services/databank/databank.h"
33#include "spp/core/pubsub/pubsub.h"
34#include "spp/services/log/log.h"
35
36/* Utilities */
37#include "spp/util/macros.h"
38#include "spp/util/crc.h"
39#include "spp/util/structof.h"
40
41#endif /* SPP_H */
core.h
SPP core initialisation and port registration API.
crc.h
CRC-16/CCITT checksum utility.
databank.h
Static packet pool manager.
gpio.h
SPP GPIO HAL API — dispatches through the registered HAL port.
hal.h
This file contains the structs that contain all the pointers to the functions that are used by the SP...
log.h
SPP logging service.
macros.h
Compile-time configuration flags and utility macros for SPP.
packet.h
Solaris Packet Protocol (SPP) packet structure definitions.
pubsub.h
Publish-subscribe packet router.
returnTypes.h
Standard return-value type used across all SPP modules.
service.h
SPP module descriptor and registry API.
spi.h
SPP SPI HAL API — dispatches through the registered HAL port.
storage.h
SPP storage HAL API — dispatches through the registered HAL port.
structof.h
Container-of macro for intrusive data structures.
time.h
SPP HAL time API — dispatches through the registered HAL port.
types.h
Portable integer types and SPI/storage configuration types for SPP.
uart.h
SPP UART HAL API — dispatches through the registered HAL port.
version.h
SPP library version constants.