Skip to content

Commit 8b0bdb8

Browse files
committed
doc(port_riscv): fix broken intra-doc links
1 parent 6b8ad9f commit 8b0bdb8

File tree

6 files changed

+20
-20
lines changed

6 files changed

+20
-20
lines changed

src/r3_port_riscv/src/lib.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ The [`PortInterrupts`] implementation generated by `use_port!` delegates method
5353
Your kernel trait type should be combined with an interrupt controller driver by implementing [`InterruptController`]. Most systems are equipped with [Platform-Level Interrupt Controller (PLIC)], whose driver is provided by [`use_plic!`]. PLIC does not support pending or clearing interrupt lines.
5454

5555
[Platform-Level Interrupt Controller (PLIC)]: https://github.com/riscv/riscv-plic-spec/blob/master/riscv-plic.adoc
56-
[`PortInterrupts`]: r3::kernel::PortInterrupts
57-
[`INTERRUPT_HANDLERS`]: r3::kernel::KernelCfg2::INTERRUPT_HANDLERS
56+
[`PortInterrupts`]: r3_kernel::PortInterrupts
57+
[`INTERRUPT_HANDLERS`]: r3_kernel::KernelCfg2::INTERRUPT_HANDLERS
5858

5959
# Emulation
6060

@@ -185,11 +185,11 @@ struct ContextState {
185185

186186
`x2` (`sp`) is stored in [`TaskCb::port_task_state`]. The stored stack pointer is only aligned to word boundaries.
187187

188-
[`TaskCb::port_task_state`]: r3::kernel::TaskCb::port_task_state
188+
[`TaskCb::port_task_state`]: r3_kernel::TaskCb::port_task_state
189189

190190
The idle task (the implicit task that runs when `*`[`running_task_ptr`]`().is_none()`) always execute with `sp == 0`. For the idle task, saving and restoring the context store is essentially replaced with no-op or loads of hard-coded values. In particular, `pc` is always “restored” with the entry point of the idle task.
191191

192-
[`running_task_ptr`]: r3::kernel::State::running_task_ptr
192+
[`running_task_ptr`]: r3_kernel::State::running_task_ptr
193193

194194
When a task is activated, a new context state is created inside the task's stack. By default, only essential registers are preloaded with known values. The **`preload-registers`** Cargo feature enables preloading for all `x` registers, which might help in debugging at the cost of performance and code size.
195195

src/r3_port_riscv/src/lib.rs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ pub mod rt {
5656
pub mod imp;
5757
}
5858

59-
/// The [`r3::kernel::PortThreading`] implementation.
59+
/// The [`r3_kernel::PortThreading`] implementation.
6060
#[doc(hidden)]
6161
pub mod threading {
6262
pub mod cfg;
@@ -107,7 +107,7 @@ pub trait Timer {
107107
/// Initialize the driver. This will be called just before entering
108108
/// [`PortToKernel::boot`].
109109
///
110-
/// [`PortToKernel::boot`]: r3::kernel::PortToKernel::boot
110+
/// [`PortToKernel::boot`]: r3_kernel::PortToKernel::boot
111111
///
112112
/// # Safety
113113
///
@@ -125,7 +125,7 @@ pub trait InterruptController {
125125
/// Initialize the driver. This will be called just before entering
126126
/// [`PortToKernel::boot`].
127127
///
128-
/// [`PortToKernel::boot`]: r3::kernel::PortToKernel::boot
128+
/// [`PortToKernel::boot`]: r3_kernel::PortToKernel::boot
129129
///
130130
/// # Safety
131131
///
@@ -146,7 +146,7 @@ pub trait InterruptController {
146146
/// The provided interrupt number must be greater than or equal to
147147
/// [`INTERRUPT_PLATFORM_START`].
148148
///
149-
/// [`PortInterrupts::set_interrupt_line_priority`]: r3::kernel::PortInterrupts::set_interrupt_line_priority
149+
/// [`PortInterrupts::set_interrupt_line_priority`]: r3_kernel::PortInterrupts::set_interrupt_line_priority
150150
///
151151
/// # Safety
152152
///
@@ -164,7 +164,7 @@ pub trait InterruptController {
164164
/// The provided interrupt number must be greater than or equal to
165165
/// [`INTERRUPT_PLATFORM_START`].
166166
///
167-
/// [`PortInterrupts::enable_interrupt_line`]: r3::kernel::PortInterrupts::enable_interrupt_line
167+
/// [`PortInterrupts::enable_interrupt_line`]: r3_kernel::PortInterrupts::enable_interrupt_line
168168
///
169169
/// # Safety
170170
///
@@ -179,7 +179,7 @@ pub trait InterruptController {
179179
/// The provided interrupt number must be greater than or equal to
180180
/// [`INTERRUPT_PLATFORM_START`].
181181
///
182-
/// [`PortInterrupts::disable_interrupt_line`]: r3::kernel::PortInterrupts::disable_interrupt_line
182+
/// [`PortInterrupts::disable_interrupt_line`]: r3_kernel::PortInterrupts::disable_interrupt_line
183183
///
184184
/// # Safety
185185
///
@@ -194,7 +194,7 @@ pub trait InterruptController {
194194
/// The provided interrupt number must be greater than or equal to
195195
/// [`INTERRUPT_PLATFORM_START`].
196196
///
197-
/// [`PortInterrupts::pend_interrupt_line`]: r3::kernel::PortInterrupts::pend_interrupt_line
197+
/// [`PortInterrupts::pend_interrupt_line`]: r3_kernel::PortInterrupts::pend_interrupt_line
198198
///
199199
/// # Safety
200200
///
@@ -209,7 +209,7 @@ pub trait InterruptController {
209209
/// The provided interrupt number must be greater than or equal to
210210
/// [`INTERRUPT_PLATFORM_START`].
211211
///
212-
/// [`PortInterrupts::clear_interrupt_line`]: r3::kernel::PortInterrupts::clear_interrupt_line
212+
/// [`PortInterrupts::clear_interrupt_line`]: r3_kernel::PortInterrupts::clear_interrupt_line
213213
///
214214
/// # Safety
215215
///
@@ -224,7 +224,7 @@ pub trait InterruptController {
224224
/// The provided interrupt number must be greater than or equal to
225225
/// [`INTERRUPT_PLATFORM_START`].
226226
///
227-
/// [`PortInterrupts::is_interrupt_line_pending`]: r3::kernel::PortInterrupts::is_interrupt_line_pending
227+
/// [`PortInterrupts::is_interrupt_line_pending`]: r3_kernel::PortInterrupts::is_interrupt_line_pending
228228
///
229229
/// # Safety
230230
///

src/r3_port_riscv/src/threading/cfg.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ pub trait ThreadingOptions {}
2020
/// [`PortInterrupts`], and [`EntryPoint`].
2121
/// **Requires [`ThreadingOptions`] and [`InterruptController`].**
2222
///
23-
/// [`PortThreading`]: r3::kernel::PortThreading
24-
/// [`PortInterrupts`]: r3::kernel::PortInterrupts
23+
/// [`PortThreading`]: r3_kernel::PortThreading
24+
/// [`PortInterrupts`]: r3_kernel::PortInterrupts
2525
/// [`EntryPoint`]: crate::EntryPoint
2626
/// [`InterruptController`]: crate::InterruptController
2727
#[macro_export]

src/r3_port_riscv/src/threading/imp.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -507,7 +507,7 @@ impl State {
507507
/// - Update SP to point to the main stack. In this case, **this
508508
/// procedure may overwrite any contents in the main stack.**
509509
/// - **`dispatch:`** (alternate entry point)
510-
/// - Call [`r3::kernel::PortToKernel::choose_running_task`].
510+
/// - Call [`r3_kernel::PortToKernel::choose_running_task`].
511511
/// - Restore SP from the next scheduled task's `TaskState`.
512512
/// - If there's no task to schedule, branch to the idle task loop.
513513
/// - Pop the second-level state of the next scheduled task.

src/r3_port_riscv/src/timer/cfg.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ use r3::kernel::InterruptNum;
66
/// implements [`Timer`] on the system type.
77
/// **Requires [`TimerOptions`].**
88
///
9-
/// [`PortTimer`]: r3::kernel::PortTimer
9+
/// [`PortTimer`]: r3_kernel::PortTimer
1010
/// [`Timer`]: crate::Timer
1111
///
1212
/// You should do the following:

src/r3_port_riscv/src/timer/imp.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ pub fn init<Traits: TimerInstance>() {
9393
}
9494
}
9595

96-
/// Implements [`r3::kernel::PortTimer::tick_count`]
96+
/// Implements [`r3_kernel::PortTimer::tick_count`]
9797
///
9898
/// # Safety
9999
///
@@ -108,7 +108,7 @@ pub unsafe fn tick_count<Traits: TimerInstance>() -> UTicks {
108108
tstate.tick_count(tcfg, hw_tick_count)
109109
}
110110

111-
/// Implements [`r3::kernel::PortTimer::pend_tick`]
111+
/// Implements [`r3_kernel::PortTimer::pend_tick`]
112112
///
113113
/// # Safety
114114
///
@@ -118,7 +118,7 @@ pub unsafe fn pend_tick<Traits: TimerInstance>() {
118118
Traits::mtimecmp_reg32()[1].set(0);
119119
}
120120

121-
/// Implements [`r3::kernel::PortTimer::pend_tick_after`]
121+
/// Implements [`r3_kernel::PortTimer::pend_tick_after`]
122122
///
123123
/// # Safety
124124
///

0 commit comments

Comments
 (0)