Skip to content

Commit f4db2da

Browse files
committed
feat(r3): rename *::{build → define}
Leaves room for a runtime builder.
1 parent 7ed52b3 commit f4db2da

File tree

102 files changed

+386
-370
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+386
-370
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
8585
System::configure_systick(b);
8686

8787
Objects {
88-
task: Task::build()
88+
task: Task::define()
8989
.start(task_body)
9090
.priority(2)
9191
.active(true)

examples/basic/src/main.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,14 @@ const COTTAGE: Objects = r3_kernel::build!(SystemTraits, configure_app => Object
2525
const fn configure_app(b: &mut r3_kernel::Cfg<'_, SystemTraits>) -> Objects {
2626
b.num_task_priority_levels(4);
2727

28-
let task1 = Task::build()
28+
let task1 = Task::define()
2929
.start(task1_body)
3030
.priority(2)
3131
.active(true)
3232
.finish(b);
33-
let task2 = Task::build().start(task2_body).priority(3).finish(b);
33+
let task2 = Task::define().start(task2_body).priority(3).finish(b);
3434

35-
let mutex1 = Mutex::build().finish(b);
35+
let mutex1 = Mutex::define().finish(b);
3636

3737
Objects {
3838
task1,

examples/basic_gr_peach/src/main.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
7070
SystemTraits::configure_os_timer(b);
7171

7272
// Initialize the serial port
73-
StartupHook::build()
73+
StartupHook::define()
7474
.start(|_| {
7575
use support_rza1::serial::ScifExt;
7676

@@ -89,12 +89,12 @@ const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
8989
})
9090
.finish(b);
9191

92-
let task1 = Task::build()
92+
let task1 = Task::define()
9393
.start(task1_body)
9494
.priority(2)
9595
.active(true)
9696
.finish(b);
97-
let task2 = Task::build().start(task2_body).priority(3).finish(b);
97+
let task2 = Task::define().start(task2_body).priority(3).finish(b);
9898

9999
Objects { task1, task2 }
100100
}

examples/basic_nucleo_f401re/src/main.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,22 +47,22 @@ const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
4747

4848
// Initialize RTT (Real-Time Transfer) with a single up channel and set
4949
// it as the print channel for the printing macros
50-
StartupHook::build()
50+
StartupHook::define()
5151
.start(|_| {
5252
rtt_target::rtt_init_print!();
5353
})
5454
.finish(b);
5555

5656
SystemTraits::configure_systick(b);
5757

58-
let task1 = Task::build()
58+
let task1 = Task::define()
5959
.start(task1_body)
6060
.priority(2)
6161
.active(true)
6262
.finish(b);
63-
let task2 = Task::build().start(task2_body).priority(3).finish(b);
63+
let task2 = Task::define().start(task2_body).priority(3).finish(b);
6464

65-
let mutex1 = Mutex::build().finish(b);
65+
let mutex1 = Mutex::define().finish(b);
6666

6767
Objects {
6868
task1,

examples/basic_rp_pico/src/main.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ const COTTAGE: Objects = r3_kernel::build!(SystemTraits, configure_app => Object
7373
const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
7474
b.num_task_priority_levels(4);
7575

76-
StartupHook::build()
76+
StartupHook::define()
7777
.start(|_| {
7878
// Configure peripherals
7979
let p = unsafe { rp2040::Peripherals::steal() };
@@ -115,14 +115,14 @@ const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
115115

116116
SystemTraits::configure_systick(b);
117117

118-
let task1 = Task::build()
118+
let task1 = Task::define()
119119
.start(task1_body)
120120
.priority(2)
121121
.active(true)
122122
.finish(b);
123-
let task2 = Task::build().start(task2_body).priority(3).finish(b);
123+
let task2 = Task::define().start(task2_body).priority(3).finish(b);
124124

125-
let mutex1 = Mutex::build().finish(b);
125+
let mutex1 = Mutex::define().finish(b);
126126

127127
Objects {
128128
task1,

examples/basic_wio_terminal/src/main.rs

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
109109
b.num_task_priority_levels(4);
110110

111111
// Register a hook to initialize hardware
112-
StartupHook::build()
112+
StartupHook::define()
113113
.start(|_| {
114114
init_hardware();
115115
})
@@ -119,65 +119,65 @@ const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
119119
SystemTraits::configure_systick(b);
120120

121121
// Miscellaneous tasks
122-
let _noisy_task = Task::build()
122+
let _noisy_task = Task::define()
123123
.start(noisy_task_body)
124124
.priority(0)
125125
.active(true)
126126
.finish(b);
127-
let button_reporter_task = Task::build()
127+
let button_reporter_task = Task::define()
128128
.start(button_reporter_task_body)
129129
.priority(2)
130130
.active(true)
131131
.finish(b);
132-
let _blink_task = Task::build()
132+
let _blink_task = Task::define()
133133
.start(blink_task_body)
134134
.priority(1)
135135
.active(true)
136136
.finish(b);
137137

138138
// USB input handler
139-
let usb_in_task = Task::build()
139+
let usb_in_task = Task::define()
140140
.start(usb_in_task_body)
141141
.priority(2)
142142
.active(true)
143143
.finish(b);
144-
let usb_poll_timer = Timer::build()
144+
let usb_poll_timer = Timer::define()
145145
.start(usb_poll_timer_handler)
146146
.delay(r3::time::Duration::from_millis(0))
147147
// Should be < 10ms for USB compliance
148148
.period(r3::time::Duration::from_millis(5))
149149
.finish(b);
150150
let usb_interrupt_lines = [
151-
InterruptLine::build()
151+
InterruptLine::define()
152152
.line(interrupt::USB_OTHER as InterruptNum + port::INTERRUPT_EXTERNAL0)
153153
.priority(1)
154154
.enabled(true)
155155
.finish(b),
156-
InterruptLine::build()
156+
InterruptLine::define()
157157
.line(interrupt::USB_TRCPT0 as InterruptNum + port::INTERRUPT_EXTERNAL0)
158158
.priority(1)
159159
.enabled(true)
160160
.finish(b),
161-
InterruptLine::build()
161+
InterruptLine::define()
162162
.line(interrupt::USB_TRCPT1 as InterruptNum + port::INTERRUPT_EXTERNAL0)
163163
.priority(1)
164164
.enabled(true)
165165
.finish(b),
166166
];
167167

168168
// Graphics-related tasks and objects
169-
let _animation_task = Task::build()
169+
let _animation_task = Task::define()
170170
.start(animation_task_body)
171171
.priority(2)
172172
.active(true)
173173
.finish(b);
174-
let _console_task = Task::build()
174+
let _console_task = Task::define()
175175
.start(console_task_body)
176176
.priority(3)
177177
.active(true)
178178
.finish(b);
179179
let console_pipe = queue::Queue::new(b);
180-
let lcd_mutex = Mutex::build().finish(b);
180+
let lcd_mutex = Mutex::define().finish(b);
181181

182182
Objects {
183183
console_pipe,
@@ -686,9 +686,9 @@ mod queue {
686686
C: ~const traits::CfgBase<System = System> + ~const traits::CfgMutex,
687687
{
688688
Self {
689-
st: Mutex::build().finish(cfg),
690-
reader_lock: Mutex::build().finish(cfg),
691-
writer_lock: Mutex::build().finish(cfg),
689+
st: Mutex::define().finish(cfg),
690+
reader_lock: Mutex::define().finish(cfg),
691+
writer_lock: Mutex::define().finish(cfg),
692692
}
693693
}
694694

examples/smp_rp_pico/src/core0.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ const COTTAGE: Objects = r3_kernel::build!(SystemTraits, configure_app => Object
5454
const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
5555
b.num_task_priority_levels(4);
5656

57-
StartupHook::build()
57+
StartupHook::define()
5858
.start(|_| {
5959
// Configure peripherals
6060
let p = unsafe { rp2040::Peripherals::steal() };
@@ -87,26 +87,26 @@ const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
8787

8888
SystemTraits::configure_systick(b);
8989

90-
let task1 = Task::build()
90+
let task1 = Task::define()
9191
.start(task1_body)
9292
.priority(2)
9393
.active(true)
9494
.finish(b);
95-
let task2 = Task::build().start(task2_body).priority(3).finish(b);
95+
let task2 = Task::define().start(task2_body).priority(3).finish(b);
9696

97-
let mutex1 = Mutex::build().finish(b);
97+
let mutex1 = Mutex::define().finish(b);
9898

9999
// Listen for messages from core1
100100
let int_fifo = rp2040::Interrupt::SIO_IRQ_PROC0 as InterruptNum + port::INTERRUPT_EXTERNAL0;
101-
InterruptLine::build()
101+
InterruptLine::define()
102102
.line(int_fifo)
103103
// The priority should be lower than USB interrupts so that USB packets
104104
// can handled by the USB interrupt handler while we are doing
105105
// `write_bytes`
106106
.priority(0x40)
107107
.enabled(true)
108108
.finish(b);
109-
InterruptHandler::build()
109+
InterruptHandler::define()
110110
.line(int_fifo)
111111
.start(|_| {
112112
let p = unsafe { rp2040::Peripherals::steal() };

examples/smp_rp_pico/src/core1.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ const fn configure_app(b: &mut r3_kernel::Cfg<SystemTraits>) -> Objects {
180180

181181
SystemTraits::configure_systick(b);
182182

183-
let task1 = Task::build()
183+
let task1 = Task::define()
184184
.start(task1_body)
185185
.priority(2)
186186
.active(true)

src/r3/src/hunk.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ unsafe impl<System, T: ?Sized + Sync> Sync for Hunk<System, T> {}
4646
impl<System: raw::KernelBase + cfg::KernelStatic, T: ?Sized> Hunk<System, T> {
4747
/// Construct a `HunkDefiner` to define a hunk in [a configuration
4848
/// function](crate#static-configuration).
49-
pub const fn build() -> HunkDefiner<System, T, DefaultInitTag> {
49+
pub const fn define() -> HunkDefiner<System, T, DefaultInitTag> {
5050
HunkDefiner {
5151
_phantom: PhantomData,
5252
len: 1,
@@ -151,7 +151,7 @@ impl<System: raw::KernelBase + cfg::KernelStatic, T, InitTag: HunkIniter<T>>
151151
self,
152152
cfg: &mut Cfg<C>,
153153
) -> Hunk<System, T> {
154-
let untyped_hunk = kernel::Hunk::<System>::build()
154+
let untyped_hunk = kernel::Hunk::<System>::define()
155155
.len(mem::size_of::<T>())
156156
.align(max(mem::align_of::<T>(), self.align))
157157
.finish(cfg);
@@ -163,7 +163,7 @@ impl<System: raw::KernelBase + cfg::KernelStatic, T, InitTag: HunkIniter<T>>
163163
// Insert an initializer
164164
if InitTag::NEEDS_INIT {
165165
unsafe {
166-
StartupHook::build()
166+
StartupHook::define()
167167
.priority(INIT_HOOK_PRIORITY)
168168
.start(|start| {
169169
let untyped_hunk = kernel::Hunk::<System>::from_offset(start).as_ptr();
@@ -193,7 +193,7 @@ impl<System: raw::KernelBase + cfg::KernelStatic, T, InitTag: HunkIniter<T>>
193193
) -> Hunk<System, [T]> {
194194
assert!(self.align.is_power_of_two(), "`align` is not power of two");
195195

196-
let untyped_hunk = kernel::Hunk::<System>::build()
196+
let untyped_hunk = kernel::Hunk::<System>::define()
197197
.len(mem::size_of::<T>() * self.len)
198198
.align(max(mem::align_of::<T>(), self.align))
199199
.finish(cfg);

src/r3/src/kernel/event_group.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ impl<System: raw::KernelEventGroup> EventGroup<System> {
8989
impl<System: raw::KernelEventGroup> EventGroup<System> {
9090
/// Construct a `EventGroupDefiner` to define an event group in [a
9191
/// configuration function](crate#static-configuration).
92-
pub const fn build() -> EventGroupDefiner<System> {
92+
pub const fn define() -> EventGroupDefiner<System> {
9393
EventGroupDefiner::new()
9494
}
9595

0 commit comments

Comments
 (0)