serial.h

Go to the documentation of this file.

/*
 * SPDX-License-Identifier: GPL-3.0-only
 * This file is part of Lazuli.
 */

#ifndef LAZULI_SERIAL_H
#define LAZULI_SERIAL_H

#include <Lazuli/common.h>

_EXTERN_C_DECL_BEGIN

enum Lz_SerialEnableFlags {
  LZ_SERIAL_DISABLE_ALL = 0,

  LZ_SERIAL_ENABLE_TRANSMIT = POSITION(1U),

  LZ_SERIAL_ENABLE_RECEIVE = POSITION(2U),

  LZ_SERIAL_ENABLE_ALL = LZ_SERIAL_ENABLE_RECEIVE | LZ_SERIAL_ENABLE_TRANSMIT
};

enum Lz_SerialStopBits {
  __LZ_SERIAL_STOP_BITS_ENUM_BEGIN = -1,

  LZ_SERIAL_STOP_BITS_1,

  LZ_SERIAL_STOP_BITS_2,

  __LZ_SERIAL_STOP_BITS_ENUM_END

};

enum Lz_SerialParityBit {
  __LZ_SERIAL_PARITY_BIT_ENUM_BEGIN = -1,

  LZ_SERIAL_PARITY_NONE,

  LZ_SERIAL_PARITY_EVEN,

  LZ_SERIAL_PARITY_ODD,

  __LZ_SERIAL_PARITY_BIT_ENUM_END

};

enum Lz_SerialSize {
  __LZ_SERIAL_SIZE_ENUM_BEGIN = -1,

  LZ_SERIAL_SIZE_5,

  LZ_SERIAL_SIZE_6,

  LZ_SERIAL_SIZE_7,

  LZ_SERIAL_SIZE_8,

  __LZ_SERIAL_SIZE_ENUM_END

};

enum Lz_SerialSpeed {
  __LZ_SERIAL_SPEED_ENUM_BEGIN = -1,

  LZ_SERIAL_SPEED_2400,

  LZ_SERIAL_SPEED_4800,

  LZ_SERIAL_SPEED_9600,

  LZ_SERIAL_SPEED_19200,

  __LZ_SERIAL_SPEED_ENUM_END

};

typedef struct {
  enum Lz_SerialEnableFlags enableFlags;

  enum Lz_SerialStopBits stopBits;

  enum Lz_SerialParityBit parityBit;

  enum Lz_SerialSize size;

  enum Lz_SerialSpeed speed;
}Lz_SerialConfiguration;

void
Lz_Serial_GetConfiguration(Lz_SerialConfiguration * const serialConfiguration);

void
Lz_Serial_SetConfiguration(Lz_SerialConfiguration * const serialConfiguration);

_EXTERN_C_DECL_END

#endif /* LAZULI_SERIAL_H */