IgrOS-Kernel 0.1.34.545
Simple C++20 Kernel for i386/x86_64
Loading...
Searching...
No Matches
serial.hpp
Go to the documentation of this file.
1
11
12
13#pragma once
14
15
16// IgrOS-Kernel arch
17// C++
18#include <span>
19#include <string_view>
20// IgrOS-Kernel arch
21#include <arch/types.hpp>
22
23
24// Arch-dependent code zone
25namespace igros::arch {
26
27
30 COM1 = 0x03F8_u16,
31 COM2 = 0x02F8_u16,
32 COM3 = 0x03E8_u16,
33 COM4 = 0x02E8_u16,
34 };
35
37 enum class BAUD_RATE : igros_dword_t {
38 BAUD_110 = 110_u32,
39 BAUD_300 = 300_u32,
40 BAUD_600 = 600_u32,
41 BAUD_1200 = 1200_u32,
42 BAUD_2400 = 2400_u32,
43 BAUD_4800 = 4800_u32,
44 BAUD_9600 = 9600_u32,
45 BAUD_14400 = 14400_u32,
46 BAUD_19200 = 19200_u32,
47 BAUD_38400 = 38400_u32,
48 BAUD_57600 = 57600_u32,
49 BAUD_115200 = 115200_u32,
50 };
51
53 enum class DATA_SIZE : igros_byte_t {
54 CHAR_5 = 0x00,
55 CHAR_6 = 0x01,
56 CHAR_7 = 0x02,
57 CHAR_8 = 0x03,
58 };
59
61 enum class STOP_BITS : igros_byte_t {
62 STOP_1 = 0x00_u8,
63 STOP_1_5 = 0x01_u8,
64 STOP_2 = 0x03_u8,
65 };
66
68 enum class PARITY : igros_byte_t {
69 NONE = 0x00_u8,
70 ODD = 0x01_u8,
71 EVEN = 0x02_u8,
72 MARK = 0x05_u8,
73 SPACE = 0x07_u8,
74 };
75
76
84 [[nodiscard]]
85 auto serialInit(const SERIAL_PORT port, const BAUD_RATE baudRate, const DATA_SIZE dataSize, const STOP_BITS stopBits, const PARITY parity) noexcept -> bool;
86
90 [[nodiscard]]
91 auto serialReadyWrite(const SERIAL_PORT port) noexcept -> bool;
95 [[nodiscard]]
96 auto serialReadyRead(const SERIAL_PORT port) noexcept -> bool;
97
102 [[maybe_unused]]
103 auto serialWrite(const SERIAL_PORT port, const std::string_view text) noexcept -> igros_usize_t;
108 [[maybe_unused]]
109 auto serialRead(const SERIAL_PORT port, const std::span<char> buffer) noexcept -> igros_usize_t;
110
114 [[maybe_unused]]
115 auto serialWrite(const std::string_view text) noexcept -> igros_usize_t;
119 [[maybe_unused]]
120 auto serialWrite(const char* const src) noexcept -> igros_usize_t;
121
124 [[nodiscard]]
125 auto serialSetup() noexcept -> bool;
126
127
128} // namespace igros::arch
129
std::uint16_t igros_word_t
16-bit unsigned integer
Definition types.hpp:42
std::size_t igros_usize_t
Unsigned size.
Definition types.hpp:51
std::uint8_t igros_byte_t
8-bit unsigned integer
Definition types.hpp:41
std::uint32_t igros_dword_t
32-bit unsigned integer
Definition types.hpp:43
Architecture-independent interface: drivers and aliases of current architecture types.
auto serialWrite(const SERIAL_PORT port, const std::string_view text) noexcept -> igros_usize_t
Serial write.
Definition serial.cpp:242
auto serialRead(const SERIAL_PORT port, const std::span< char > buffer) noexcept -> igros_usize_t
Serial read.
Definition serial.cpp:254
auto serialReadyWrite(const SERIAL_PORT port) noexcept -> bool
Is write ready?
Definition serial.cpp:181
auto serialInit(const SERIAL_PORT port, const BAUD_RATE baudRate, const DATA_SIZE dataSize, const STOP_BITS stopBits, const PARITY parity) noexcept -> bool
Initialize serial port.
Definition serial.cpp:120
auto serialSetup() noexcept -> bool
Setup COM1 (115200 8N1) with receive interrupt.
Definition serial.cpp:298
BAUD_RATE
Baud rates.
Definition serial.hpp:37
STOP_BITS
Stop bits.
Definition serial.hpp:61
DATA_SIZE
Data size.
Definition serial.hpp:53
SERIAL_PORT
Serial ports (standard PC I/O bases).
Definition serial.hpp:29
auto serialReadyRead(const SERIAL_PORT port) noexcept -> bool
Is read ready?
Definition serial.cpp:187
PARITY
Parity.
Definition serial.hpp:68
Common C++ types redefinition.