1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use crate::*;
pub(crate) fn new() -> Item {
let docs = docs!();
let name = "uart".into();
let items = vec![
item! {
/// Returns how many UARTs are on the device.
fn count "uac" {} -> usize
},
item! {
/// Sets the baudrate of a stopped UART.
fn set_baudrate "uaz" {
/// Index of the UART to configure.
uart: usize,
/// Baudrate to configure.
baudrate: usize,
} -> ()
},
item! {
/// Starts a UART.
fn start "uaa" {
/// Index of the UART to start.
uart: usize,
} -> ()
},
item! {
/// Stops a UART.
fn stop "uab" {
/// Index of the UART to stop.
uart: usize,
} -> ()
},
item! {
/// Reads from a UART into a buffer.
///
/// Returns the number of bytes read. This function does not block and may return zero.
fn read "uar" {
/// Index of the UART to read from.
uart: usize,
/// Address of the buffer.
ptr: *mut u8,
/// Length of the buffer in bytes.
len: usize,
} -> usize
},
item! {
/// Writes to a UART from a buffer.
///
/// Returns the number of bytes written. This function does not block and may return
/// zero.
fn write "uaw" {
/// Index of the UART to write to.
uart: usize,
/// Address of the buffer.
ptr: *const u8,
/// Length of the buffer in bytes.
len: usize,
} -> usize
},
item! {
/// UART events.
enum Event {
/// Ready for read.
Read = 0,
/// Ready for write.
Write = 1,
}
},
item! {
/// Registers a callback when a UART is ready.
///
/// It is possible that the callback is spuriously called. The callback is only
/// guaranteed to be called after the associated operation processed less bytes than the
/// buffer size.
fn register "uae" {
/// Index of the UART to listen to.
uart: usize,
/// Event to listen to.
event: usize,
/// Function pointer of the closure to call on events.
handler_func: fn { data: *const void },
/// Opaque data of the closure to call on events.
handler_data: *const void,
} -> ()
},
item! {
/// Unregisters a callback.
fn unregister "uad" {
/// Index of the UART to stop listening to.
uart: usize,
/// Event to stop listening to.
event: usize,
} -> ()
},
];
Item::Mod(Mod { docs, name, items })
}