LibBareMetal: Creating a new library for freestanding environments

Libraries/LibBareMetal/IO.h

@@ -0,0 +1,103 @@
+/*
+ * Copyright (c) 2018-2020, Andreas Kling <[email protected]>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#pragma once
+
+#include <AK/Types.h>
+
+#if defined(KERNEL)
+# include <Kernel/Arch/i386/CPU.h>
+# include <Kernel/Devices/VMWareBackdoor.h>
+#endif
+
+namespace IO {
+
+inline u8 in8(u16 port)
+{
+ u8 value;
+ asm volatile("inb %1, %0"
+ : "=a"(value)
+ : "Nd"(port));
+ return value;
+}
+
+inline u16 in16(u16 port)
+{
+ u16 value;
+ asm volatile("inw %1, %0"
+ : "=a"(value)
+ : "Nd"(port));
+ return value;
+}
+
+inline u32 in32(u16 port)
+{
+ u32 value;
+ asm volatile("inl %1, %0"
+ : "=a"(value)
+ : "Nd"(port));
+ return value;
+}
+
+inline void repeated_in16(u16 port, u8* buffer, int buffer_size)
+{
+ asm volatile("rep insw"
+ : "+D"(buffer), "+c"(buffer_size)
+ : "d"(port)
+ : "memory");
+}
+
+inline void out8(u16 port, u8 value)
+{
+ asm volatile("outb %0, %1" ::"a"(value), "Nd"(port));
+}
+
+inline void out16(u16 port, u16 value)
+{
+ asm volatile("outw %0, %1" ::"a"(value), "Nd"(port));
+}
+
+inline void out32(u16 port, u32 value)
+{
+ asm volatile("outl %0, %1" ::"a"(value), "Nd"(port));
+}
+
+inline void repeated_out16(u16 port, const u8* data, int data_size)
+{
+ asm volatile("rep outsw"
+ : "+S"(data), "+c"(data_size)
+ : "d"(port));
+}
+
+inline void delay()
+{
+ // ~3 microsecs
+ for (auto i = 0; i < 32; i++) {
+ IO::in8(0x80);
+ }
+}
+
+}

Libraries/LibBareMetal/Makefile

@@ -0,0 +1 @@
+include ../../Makefile.common

Libraries/LibBareMetal/Output/Console.cpp

@@ -0,0 +1,97 @@
+/*
+ * Copyright (c) 2018-2020, Andreas Kling <[email protected]>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <LibBareMetal/IO.h>
+#include <LibBareMetal/Output/Console.h>
+#include <LibBareMetal/Output/kstdio.h>
+
+// Bytes output to 0xE9 end up on the Bochs console. It's very handy.
+#define CONSOLE_OUT_TO_E9
+
+static Console* s_the;
+
+Console& Console::the()
+{
+ ASSERT(s_the);
+ return *s_the;
+}
+
+bool Console::is_initialized()
+{
+ return s_the != nullptr;
+}
+
+Console::Console()
+#if defined(KERNEL)
+ : CharacterDevice(5, 1)
+#endif
+{
+ s_the = this;
+}
+
+Console::~Console()
+{
+}
+
+#if defined(KERNEL)
+bool Console::can_read(const FileDescription&) const
+{
+ return false;
+}
+
+ssize_t Console::read(FileDescription&, u8*, ssize_t)
+{
+ // FIXME: Implement reading from the console.
+ // Maybe we could use a ring buffer for this device?
+ return 0;
+}
+
+ssize_t Console::write(FileDescription&, const u8* data, ssize_t size)
+{
+ if (!size)
+ return 0;
+ if (!m_implementation)
+ return 0;
+ for (ssize_t i = 0; i < size; ++i)
+ put_char(data[i]);
+ return size;
+}
+#endif
+
+void Console::put_char(char ch)
+{
+#ifdef CONSOLE_OUT_TO_E9
+ //if (ch != 27)
+ IO::out8(0xe9, ch);
+#endif
+ m_logbuffer.enqueue(ch);
+ if (m_implementation)
+ m_implementation->on_sysconsole_receive(ch);
+}
+
+ConsoleImplementation::~ConsoleImplementation()
+{
+}

Libraries/LibBareMetal/Output/Console.h

@@ -0,0 +1,78 @@
+/*
+ * Copyright (c) 2018-2020, Andreas Kling <[email protected]>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#pragma once
+
+#include <AK/CircularQueue.h>
+#include <AK/Vector.h>
+#if defined(KERNEL)
+# include <Kernel/Devices/CharacterDevice.h>
+#endif
+
+class ConsoleImplementation {
+public:
+ virtual ~ConsoleImplementation();
+ virtual void on_sysconsole_receive(u8) = 0;
+};
+
+#if defined(KERNEL)
+class Console final : public CharacterDevice {
+ AK_MAKE_ETERNAL
+#elif defined(BOOTSTRAPPER)
+class Console {
+#endif
+public:
+ static Console& the();
+ static bool is_initialized();
+
+ Console();
+#if defined(KERNEL)
+ virtual ~Console() override;
+#elif defined(BOOTSTRAPPER)
+ virtual ~Console();
+#endif
+
+#if defined(KERNEL)
+ // ^CharacterDevice
+ virtual bool can_read(const FileDescription&) const override;
+ virtual bool can_write(const FileDescription&) const override { return true; }
+ virtual ssize_t read(FileDescription&, u8*, ssize_t) override;
+ virtual ssize_t write(FileDescription&, const u8*, ssize_t) override;
+ virtual const char* class_name() const override { return "Console"; }
+#endif
+ void set_implementation(ConsoleImplementation* implementation)
+ {
+ m_implementation = implementation;
+ }
+
+ void put_char(char);
+
+ const CircularQueue<char, 16384>& logbuffer() const { return m_logbuffer; }
+
+private:
+ ConsoleImplementation* m_implementation { nullptr };
+ CircularQueue<char, 16384> m_logbuffer;
+};