doc: system type → kernel trait type, update code examples

Author: yvt

src/r3_port_arm_m/src/systick_tickful/cfg.rs

@@ -47,15 +47,15 @@ pub trait SysTickOptions {
 ///    See the following example.
 ///
 /// ```rust,ignore
-/// r3_port_arm_m::use_systick_tickful!(unsafe impl PortTimer for System);
+/// r3_port_arm_m::use_systick_tickful!(unsafe impl PortTimer for SystemTraits);
 ///
-/// impl r3_port_arm_m::SysTickOptions for System {
+/// impl r3_port_arm_m::SysTickOptions for SystemTraits {
 ///    // SysTick = AHB/8, AHB = HSI (internal 16-MHz RC oscillator)
 ///     const FREQUENCY: u64 = 2_000_000;
 /// }
 ///
-/// const fn configure_app(b: &mut CfgBuilder<System>) -> Objects {
-///     System::configure_systick(b);
+/// const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
+///     SystemTraits::configure_systick(b);
 ///     /* ... */
 /// }
 /// ```

src/r3_port_arm_m/src/systick_tickful/imp.rs

@@ -9,7 +9,7 @@ use r3_portkit::tickful::{TickfulCfg, TickfulOptions, TickfulState, TickfulState
 
 use crate::{SysTickOptions, INTERRUPT_SYSTICK};
 
-/// Implemented on a system type by [`use_systick_tickful!`].
+/// Implemented on a kernel trait type by [`use_systick_tickful!`].
 ///
 /// # Safety
 ///

src/r3_port_riscv/src/mtime/cfg.rs

@@ -3,29 +3,29 @@ use r3_core::kernel::InterruptNum;
 
 /// Attach the implementation of [`PortTimer`] based on the RISC-V machine-mode
 /// timer (`mtime`/`mtimecfg`) to a given kernel trait type. This macro also
-/// implements [`Timer`] on the system type.
+/// implements [`Timer`] on the kernel trait type.
 /// **Requires [`MtimeOptions`].**
 ///
 /// [`PortTimer`]: r3_kernel::PortTimer
 /// [`Timer`]: crate::Timer
 ///
 /// You should do the following:
 ///
-///  - Implement [`MtimeOptions`] on the system type `$Traits`.
+///  - Implement [`MtimeOptions`] on the kernel trait type `$Traits`.
 ///  - Call `$Traits::configure_timer()` in your configuration function.
 ///    See the following example.
 ///
 /// ```rust,ignore
-/// r3_port_riscv::use_mtime!(unsafe impl PortTimer for System);
+/// r3_port_riscv::use_mtime!(unsafe impl PortTimer for SystemTraits);
 ///
-/// impl r3_port_riscv::MtimeOptions for System {
+/// impl r3_port_riscv::MtimeOptions for SystemTraits {
 ///     const MTIME_PTR: usize = 0x1001_1000;
 ///     const MTIMECMP_PTR: usize = 0x1001_1000;
 ///     const FREQUENCY: u64 = 1_000_000;
 /// }
 ///
-/// const fn configure_app(b: &mut CfgBuilder<System>) -> Objects {
-///     System::configure_timer(b);
+/// const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
+///     SystemTraits::configure_timer(b);
 ///     /* ... */
 /// }
 /// ```

src/r3_port_riscv/src/mtime/imp.rs

@@ -9,7 +9,7 @@ use tock_registers::{
 
 use crate::mtime::cfg::MtimeOptions;
 
-/// Implemented on a system type by [`use_mtime!`].
+/// Implemented on a kernel trait type by [`use_mtime!`].
 ///
 /// # Safety
 ///

src/r3_port_riscv/src/plic/cfg.rs

@@ -10,22 +10,22 @@ use super::plic_regs;
 /// [`InterruptController`]: crate::InterruptController
 /// [`InterruptControllerToPort`]: crate::InterruptControllerToPort
 ///
-/// This macro adds `const fn configure_plic(b: &mut CfgBuilder<Self>)` to the
-/// system type. **It should be called by your application's configuration
+/// This macro adds a method `const fn configure_plic(b: &mut Cfg<C>)` to the
+/// kernel trait type. **It should be called by your application's configuration
 /// function.** See the following example:
 ///
 /// ```rust,ignore
-/// r3_port_riscv::use_plic!(unsafe impl InterruptController for System);
+/// r3_port_riscv::use_plic!(unsafe impl InterruptController for SystemTraits);
 ///
-/// impl r3_port_riscv::PlicOptions for System {
+/// impl r3_port_riscv::PlicOptions for SystemTraits {
 ///     // SiFive E
 ///     const MAX_PRIORITY: InterruptPriority = 7;
 ///     const MAX_NUM: InterruptNum = 127;
 ///     const PLIC_BASE: usize = 0x0c00_0000;
 /// }
 ///
-/// const fn configure_app(b: &mut CfgBuilder<System>) -> Objects {
-///     System::configure_plic(b);
+/// const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
+///     SystemTraits::configure_plic(b);
 ///     /* ... */
 /// }
 /// ```

src/r3_port_riscv/src/sbi_timer/cfg.rs

@@ -4,7 +4,7 @@ use r3_core::kernel::InterruptNum;
 /// Attach the implementation of [`PortTimer`] based on [the RISC-V Supervisor
 /// Binary Interface][1] Timer Extension (EID #0x54494D45 "TIME") and `time[h]`
 /// CSR to a given kernel trait type.
-/// This macro also implements [`Timer`] on the system type.
+/// This macro also implements [`Timer`] on the kernel trait type.
 /// **Requires [`SbiTimerOptions`].**
 ///
 /// [1]: https://github.com/riscv-non-isa/riscv-sbi-doc
@@ -13,19 +13,19 @@ use r3_core::kernel::InterruptNum;
 ///
 /// You should do the following:
 ///
-///  - Implement [`SbiTimerOptions`] on the system type `$Traits`.
+///  - Implement [`SbiTimerOptions`] on the kernel trait type `$Traits`.
 ///  - Call `$Traits::configure_timer()` in your configuration function.
 ///    See the following example.
 ///
 /// ```rust,ignore
-/// r3_port_riscv::use_sbi_timer!(unsafe impl PortTimer for System);
+/// r3_port_riscv::use_sbi_timer!(unsafe impl PortTimer for SystemTraits);
 ///
-/// impl r3_port_riscv::SbiTimerOptions for System {
+/// impl r3_port_riscv::SbiTimerOptions for SystemTraits {
 ///     const FREQUENCY: u64 = 1_000_000;
 /// }
 ///
-/// const fn configure_app(b: &mut CfgBuilder<System>) -> Objects {
-///     System::configure_timer(b);
+/// const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
+///     SystemTraits::configure_timer(b);
 ///     /* ... */
 /// }
 /// ```

src/r3_port_riscv/src/sbi_timer/imp.rs

@@ -6,7 +6,7 @@ use r3_portkit::tickless::{TicklessCfg, TicklessStateTrait};
 
 use crate::sbi_timer::cfg::SbiTimerOptions;
 
-/// Implemented on a system type by [`use_sbi_timer!`].
+/// Implemented on a kernel trait type by [`use_sbi_timer!`].
 ///
 /// # Safety
 ///

src/r3_port_riscv/src/threading/imp.rs

@@ -156,7 +156,7 @@ pub use csr::{CsrSet, NumTy};
 #[allow(dead_code)]
 const XSTATUS_PART_MASK: usize = csr::XSTATUS_FS_1;
 
-/// Implemented on a system type by [`use_port!`].
+/// Implemented on a kernel trait type by [`use_port!`].
 ///
 /// # Safety
 ///

src/r3_port_std/src/lib.rs

@@ -75,7 +75,7 @@ pub const INTERRUPT_LINE_TIMER: InterruptNum = 1022;
 /// The default interrupt priority for [`INTERRUPT_LINE_TIMER`].
 pub const INTERRUPT_PRIORITY_TIMER: InterruptPriority = 16383;
 
-/// Implemented on a system type by [`use_port!`].
+/// Implemented on a kernel trait type by [`use_port!`].
 ///
 /// # Safety
 ///

src/r3_support_rza1/src/os_timer/imp.rs

@@ -7,7 +7,7 @@ use rza1::ostm0 as ostm;
 
 use crate::os_timer::cfg::OsTimerOptions;
 
-/// Implemented on a system type by [`use_os_timer!`].
+/// Implemented on a kernel trait type by [`use_os_timer!`].
 ///
 /// # Safety
 ///