From 16ccd51e4af56b68a88c3ea1c761f4207619f77f Mon Sep 17 00:00:00 2001 From: able Date: Tue, 13 Jun 2023 06:00:11 -0500 Subject: [PATCH] cleanup and docs --- kernel/src/arch/x86_64/pci/mod.rs | 10 +++++----- kernel/src/device_tree.rs | 14 ++++++++++++-- kernel/src/handle.rs | 17 +++++++++++------ kernel/src/host_functions.rs | 17 +++++++++++------ kernel/src/ipc/buffer.rs | 13 +++++++++---- kernel/src/ipc/mod.rs | 1 + kernel/src/kmain.rs | 4 +++- kernel/src/lib.rs | 2 +- repbuild/src/main.rs | 1 + 9 files changed, 54 insertions(+), 25 deletions(-) diff --git a/kernel/src/arch/x86_64/pci/mod.rs b/kernel/src/arch/x86_64/pci/mod.rs index 17652201..aba08a66 100644 --- a/kernel/src/arch/x86_64/pci/mod.rs +++ b/kernel/src/arch/x86_64/pci/mod.rs @@ -67,7 +67,7 @@ pub fn check_device(bus: u8, device: u8) -> Option { } let reg2 = unsafe { pci_config_read(bus, device, 0, 0x8) }; - let class = ((reg2 >> 16) & 0x0000FFFF) as u16; + let class = ((reg2 >> 16) & 0x0000_FFFF) as u16; let pci_class = PciFullClass::from_u16(class); let header_type = get_header_type(bus, device, 0); @@ -80,7 +80,7 @@ pub fn check_device(bus: u8, device: u8) -> Option { id: device_id, }, full_class: pci_class, - rev_id: (reg2 & 0x000000FF) as u8, + rev_id: (reg2 & 0x0000_00FF) as u8, }) } @@ -271,7 +271,7 @@ use core::fmt::Display; use crate::kmain::DEVICE_TREE; -use {x86_64::instructions::port::Port}; +use x86_64::instructions::port::Port; #[allow(non_camel_case_types, dead_code)] #[derive(Debug, Clone, Copy, PartialEq)] @@ -460,7 +460,7 @@ unsafe fn pci_config_read(bus: u8, device: u8, func: u8, offset: u8) -> u32 { let offset = offset as u32; // construct address param let address = - ((bus << 16) | (device << 11) | (func << 8) | (offset & 0xFC) | 0x80000000) as u32; + ((bus << 16) | (device << 11) | (func << 8) | (offset & 0xFC) | 0x8000_0000) as u32; // write address Port::new(0xCF8).write(address); @@ -476,7 +476,7 @@ unsafe fn pci_config_write(bus: u8, device: u8, func: u8, offset: u8, value: u32 let offset = offset as u32; // construct address param let address = - ((bus << 16) | (device << 11) | (func << 8) | (offset & 0xFC) | 0x80000000) as u32; + ((bus << 16) | (device << 11) | (func << 8) | (offset & 0xFC) | 0x8000_0000) as u32; // write address Port::new(0xCF8).write(address); diff --git a/kernel/src/device_tree.rs b/kernel/src/device_tree.rs index c13538c0..cffa0698 100644 --- a/kernel/src/device_tree.rs +++ b/kernel/src/device_tree.rs @@ -1,14 +1,24 @@ -use alloc::{string::String, vec::Vec}; +//! A tree of hardware devices -use {crate::alloc::string::ToString, core::fmt, hashbrown::HashMap}; +use { + crate::alloc::string::ToString, + alloc::{string::String, vec::Vec}, + core::fmt, + hashbrown::HashMap, +}; +/// A device object. +/// TODO define device pub type Device = xml::XMLElement; +/// A tree of devices // TODO: alphabatize this list #[derive(Debug)] pub struct DeviceTree { + /// The device tree pub devices: HashMap>, } impl DeviceTree { + /// Build the device tree. Does not populate the device tree pub fn new() -> Self { let mut dt = Self { devices: HashMap::new(), diff --git a/kernel/src/handle.rs b/kernel/src/handle.rs index 1e5d9ee0..9cb34c87 100644 --- a/kernel/src/handle.rs +++ b/kernel/src/handle.rs @@ -1,23 +1,28 @@ +//! A handle module + use { crate::arch::hardware_random_u64, core::fmt::{self, Formatter}, }; +/// An operating system handle without permissions attached #[derive(Debug, Eq, Hash, PartialEq, Clone, Copy)] pub struct OSHandle { - pub id: u64, + id: u64, } impl OSHandle { + /// turn a u64 into an OSHandle pub fn new_from_u64(id: u64) -> Self { Self { id } } + /// Generate a new OSHandle using the HAL random function pub fn random_new() -> Self { Self { id: hardware_random_u64(), } } } - +/// A handle for resources #[derive(Debug, Eq, Hash, PartialEq, Clone, Copy)] pub struct Handle { id: OSHandle, @@ -25,13 +30,14 @@ pub struct Handle { } impl Handle { + /// make a new handle pub fn new() -> Handle { Handle { id: OSHandle::random_new(), perms: Permissions::new(), } } - + /// represent the os handle as a u64 pub fn as_u64(&self) -> u64 { self.id.id } @@ -45,13 +51,12 @@ impl fmt::Display for Handle { } #[derive(PartialEq, Hash, Eq, Debug, Clone, Copy)] - -pub struct Permissions { +struct Permissions { edit_children: bool, edit_attributes: bool, } impl Permissions { - pub fn new() -> Self { + fn new() -> Self { Self { edit_children: true, edit_attributes: true, diff --git a/kernel/src/host_functions.rs b/kernel/src/host_functions.rs index 62b97996..9321d442 100644 --- a/kernel/src/host_functions.rs +++ b/kernel/src/host_functions.rs @@ -1,15 +1,20 @@ -use hbvm::engine::Engine; +//! the system interface use { crate::ipc::message::Message, crossbeam_queue::{ArrayQueue, SegQueue}, + hbvm::engine::Engine, log::trace, }; - +/// Host errors pub enum HostError { + /// A host memory error MemoryError, } +/// Check f0 register for the handle +/// check f1 for the message ptr +/// check f2 for the message length pub fn ipc_send(engine: &mut Engine) -> Result<(), HostError> { let _handle = engine.registers.f0; let message_start = engine.registers.f1; @@ -28,7 +33,7 @@ pub fn ipc_send(engine: &mut Engine) -> Result<(), HostError> { Ok(()) } -pub fn ipc_recv(_engine: &mut Engine) {} +// pub fn ipc_recv(_engine: &mut Engine) {} /// Check f0 for the buffer type /// 0 means an unbound buffer @@ -52,6 +57,6 @@ pub fn ipc_mkbuf(engine: &mut Engine) { } } -pub fn rpc_discover(_engine: &mut Engine) {} -pub fn rpc_register(_engine: &mut Engine) {} -pub fn rpc_call(_engine: &mut Engine) {} +// pub fn rpc_discover(_engine: &mut Engine) {} +// pub fn rpc_register(_engine: &mut Engine) {} +// pub fn rpc_call(_engine: &mut Engine) {} diff --git a/kernel/src/ipc/buffer.rs b/kernel/src/ipc/buffer.rs index d80a7cd6..646749d6 100644 --- a/kernel/src/ipc/buffer.rs +++ b/kernel/src/ipc/buffer.rs @@ -1,24 +1,29 @@ -use crossbeam_queue::{ArrayQueue, SegQueue}; +//! -use super::message::Message; +use { + super::message::Message, + crossbeam_queue::{ArrayQueue, SegQueue}, +}; enum BufferTypes { Unbound(SegQueue), Bound(ArrayQueue), } - +/// Interproccess buffer pub struct IpcBuffer { protocol: Protocol, buffer: BufferTypes, } impl IpcBuffer { + /// Validate a message to match the `IPC.protocol` pub fn validate_messages(&mut self) -> Result<(), IpcError> { Ok(()) } } - +/// Interprocess Communication Errors pub enum IpcError { + /// An invalid message error returned to the sender InvalidMessage, } diff --git a/kernel/src/ipc/mod.rs b/kernel/src/ipc/mod.rs index 11b4c20b..47dec6b4 100644 --- a/kernel/src/ipc/mod.rs +++ b/kernel/src/ipc/mod.rs @@ -1,2 +1,3 @@ +//! Interprocess communication pub mod buffer; pub mod message; diff --git a/kernel/src/kmain.rs b/kernel/src/kmain.rs index 8be8f845..c50004b0 100644 --- a/kernel/src/kmain.rs +++ b/kernel/src/kmain.rs @@ -62,8 +62,10 @@ pub fn kmain(cmdline: &str, bootstrap: Option<&'static [u8]>) -> ! { let byte = sc.receive(); if byte == b'\r' { sc.send(b'\n'); + sc.send(b'\r'); + } else { + sc.send(byte); } - sc.send(byte); } } } diff --git a/kernel/src/lib.rs b/kernel/src/lib.rs index 32fb5d20..5e32a5d7 100644 --- a/kernel/src/lib.rs +++ b/kernel/src/lib.rs @@ -16,7 +16,7 @@ #![deny(clippy::pedantic, warnings)] #![allow(dead_code)] #![test_runner(crate::test_runner)] -// #![deny(missing_docs)] +#![deny(missing_docs)] extern crate alloc; diff --git a/repbuild/src/main.rs b/repbuild/src/main.rs index 51ca04da..be8bf50e 100644 --- a/repbuild/src/main.rs +++ b/repbuild/src/main.rs @@ -9,6 +9,7 @@ fn main() -> Result<(), Error> { let mut args = std::env::args(); args.next(); // TODO: work on adding in system.toml support + // TODO: check the disk.img time and system.toml time and if system.toml is higher then rebuild the disk match args.next().as_deref() { Some("build" | "b") => {