contract.h

#pragma once

#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#include <sys/types.h>

#define REMOTEX_CONTRACT_VERSION 7

typedef enum __attribute__((packed))
{
    GPIO_OpenAsOutput_c,
    GPIO_OpenAsInput_c,
    GPIO_SetValue_c,
    GPIO_GetValue_c,

    I2CMaster_Open_c,
    I2CMaster_SetBusSpeed_c,
    I2CMaster_SetTimeout_c,
    I2CMaster_Write_c,
    I2CMaster_WriteThenRead_c,
    I2CMaster_Read_c,
    I2CMaster_SetDefaultTargetAddress_c,

    SPIMaster_Open_c,
    SPIMaster_InitConfig_c,
    SPIMaster_SetBusSpeed_c,
    SPIMaster_SetMode_c,
    SPIMaster_SetBitOrder_c,
    SPIMaster_WriteThenRead_c,
    SPIMaster_TransferSequential_c,

    PWM_Open_c,
    PWM_Apply_c,

    ADC_Open_c,
    ADC_GetSampleBitCount_c,
    ADC_SetReferenceVoltage_c,
    ADC_Poll_c,

    Storage_OpenMutableFile_c,
    Storage_DeleteMutableFile_c,

    RemoteX_Write_c,
    RemoteX_Read_c,
    RemoteX_Lseek_c,
    RemoteX_Close_c,
    RemoteX_PlatformInformation_c,

    UART_InitConfig_c,
    UART_Open_c
} SOCKET_CMD;

typedef struct __attribute__((packed))
{
    uint16_t block_length;
    uint16_t response_length;
    SOCKET_CMD cmd;
    bool respond;
    uint8_t contract_version;
    int32_t err_no;
    int32_t returns;
} CTX_HEADER;

typedef struct __attribute__((packed))
{
    uint8_t flags;
    uint16_t length;
} SPI_TransferConfig;

// Note the data block sent is variable length but not greater that 4096 and must be the last field in control block
typedef struct __attribute__((packed))
{
    uint8_t data[4096];
} DATA_BLOCK;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t gpioId;
    uint8_t outputMode;
    uint8_t initialValue;
} GPIO_OpenAsOutput_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t gpioId;
} GPIO_OpenAsInput_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t gpioFd;
    uint8_t value;
} GPIO_SetValue_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t gpioFd;
    uint8_t outValue;
} GPIO_GetValue_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t I2C_InterfaceId;
} I2CMaster_Open_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t fd;
    uint32_t speedInHz;
} I2CMaster_SetBusSpeed_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t fd;
    uint32_t timeoutInMs;
} I2CMaster_SetTimeout_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t fd;
    uint8_t address;
    int32_t length;
    DATA_BLOCK data_block; // Must be the last element in the struct
} I2CMaster_Write_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t fd;
    uint8_t address;
    uint32_t lenWriteData;
    uint32_t lenReadData;
    DATA_BLOCK data_block; // Must be the last element in the struct
} I2CMaster_WriteThenRead_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t fd;
    uint8_t address;
    uint32_t maxLength;
    DATA_BLOCK data_block; // Must be the last element in the struct
} I2CMaster_Read_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t fd;
    uint8_t address;
} I2CMaster_SetDefaultTargetAddress_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    uint32_t pwm;
} PWM_Open_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t pwmFd;
    uint32_t pwmChannel;
    DATA_BLOCK data_block; // Must be the last element in the struct
} PWM_Apply_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    uint32_t id;
} ADC_Open_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t fd;
    uint32_t channel;
} ADC_GetSampleBitCount_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t fd;
    uint32_t channel;
    float referenceVoltage;
} ADC_SetReferenceVoltage_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t fd;
    uint32_t channel;
    uint32_t outSampleValue;
} ADC_Poll_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t interfaceId;
    int32_t chipSelectId;
    DATA_BLOCK data_block; // Must be the last element in the struct
} SPIMaster_Open_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    DATA_BLOCK data_block; // Must be the last element in the struct
} SPIMaster_InitConfig_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t fd;
    uint32_t speedInHz;
} SPIMaster_SetBusSpeed_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t fd;
    uint32_t mode;
} SPIMaster_SetMode_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t fd;
    uint32_t order;
} SPIMaster_SetBitOrder_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t fd;
    uint32_t lenWriteData;
    uint32_t lenReadData;
    uint32_t order;
    DATA_BLOCK data_block; // Must be the last element in the struct
} SPIMaster_WriteThenRead_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    uint32_t transferCount;
    uint32_t z__magicAndVersion;
} SPIMaster_InitTransfers_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t fd;
    uint32_t transferCount;
    int32_t length;
    DATA_BLOCK data_block; // Must be the last element in the struct
} SPIMaster_TransferSequential_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
} Storage_OpenMutableFile_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
} Storage_DeleteMutableFile_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t fd;
    int32_t length;
    DATA_BLOCK data_block; // Must be the last element in the struct
} RemoteX_Write_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t fd;
    int32_t length;
    DATA_BLOCK data_block; // Must be the last element in the struct
} RemoteX_Read_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t fd;
    off_t offset;
    int32_t whence;
} RemoteX_Lseek_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t fd;
} RemoteX_Close_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t length;
    DATA_BLOCK data_block; // Must be the last element in the struct
} RemoteX_PlatformInformation_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    DATA_BLOCK data_block; // Must be the last element in the struct
} UART_InitConfig_t;

typedef struct __attribute__((packed))
{
    CTX_HEADER header;
    int32_t uartId;
    DATA_BLOCK data_block; // Must be the last element in the struct
} UART_Open_t;