serial.h

Go to the documentation of this file.

 
// This works exactly the same as the calls on the cg50. Read more here:
// https://prizm.cemetech.net/index.php?title=Category:Syscalls:Serial
// These implementations are similar to:
// https://github.com/Jonimoose/libfxcg/blob/master/include/fxcg/serial.h
 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef __clang__
#define ro(...) __attribute__((access(read_only, __VA_ARGS__)))
#define rw(...) __attribute__((access(read_write, __VA_ARGS__)))
#define wo(...) __attribute__((access(write_only, __VA_ARGS__)))
#else
#define ro(...)
#define rw(...)
#define wo(...)
#endif
 
#include <stdint.h>
#include <stdbool.h>
 
enum Serial_Bitrate {
    SERIAL_BITRATE_300 = 0,
    SERIAL_BITRATE_1200 = 1,
    SERIAL_BITRATE_2400 = 2,
    SERIAL_BITRATE_4800 = 3,
    SERIAL_BITRATE_9600 = 5,
    SERIAL_BITRATE_19200 = 6,
    SERIAL_BITRATE_38400 = 7,
    SERIAL_BITRATE_57600 = 8,
    SERIAL_BITRATE_115200 = 9
};
 
enum Serial_Parity {
    SERIAL_PARITY_NONE = 0,
    SERIAL_PARITY_ODD = 1,
    SERIAL_PARITY_EVEN = 2
};
 
enum Serial_Data_Length {
    SERIAL_DATA_LENGTH_8BIT = 0,
    SERIAL_DATA_LENGTH_7BIT = 1
};
 
enum Serial_Stop_Bits {
    SERIAL_STOP_BITS_1 = 0,
    SERIAL_STOP_BITS_2 = 1
};
 
struct __attribute__((packed)) Serial_Settings {
    uint8_t zero;
    enum Serial_Bitrate bitrate : 8;
    enum Serial_Parity parity : 8;
    enum Serial_Data_Length data_length : 8;
    enum Serial_Stop_Bits stop_bits : 8;
    uint8_t zero2;
};
 
extern int (*Serial_Open)(const struct Serial_Settings *mode) ro(1);
 
extern int (*Serial_IsOpen)(void);
 
extern int (*Serial_Close)(bool abortPending);
 
extern int (*Serial_Read)(unsigned char *out, int sz, short *count) wo(1, 2) wo(3);
 
extern int (*Serial_ReadSingle)(unsigned char *out) wo(1);
 
extern int (*Serial_Peek)(int idx, unsigned char *out) wo(2);
 
extern int (*Serial_PollRX)(void);
 
extern int (*Serial_ClearRX)(void);
 
extern int (*Serial_Write)(const unsigned char *buf, int count) ro(1, 2);
 
extern int (*Serial_WriteSingle)(unsigned char x);
 
extern int (*Serial_WriteUnbuffered)(unsigned char x);
 
extern int (*Serial_PollTX)(void);
 
extern int (*Serial_ClearTX)(void);
 
#undef ro
#undef rw
#undef wo
 
#ifdef __cplusplus
}
#endif