RPMsg inter-partition messaging
fix(lint): resolve E410/E415 doc style issues
Add missing periods to doc comments, fix [name] format mismatches,
and add pp pretty-printer to Publicsuffix.t.
+45
-52
+3
-2
lib/rpmsg.mli
+3
-2
lib/rpmsg.mli
···
20
20
(** Matches Linux kernel [struct rpmsg_endpoint_info]. *)
21
21
22
22
val endpoint_info_codec : endpoint_info Wire.Codec.t
23
-
(** Wire codec for [rpmsg_endpoint_info]: [name[32]], [src:u32], [dst:u32]. *)
23
+
(** [endpoint_info_codec] is the wire codec for {!endpoint_info}: name[32],
24
+
src:u32, dst:u32. *)
24
25
25
26
val endpoint_info_size : int
26
-
(** Wire size of [rpmsg_endpoint_info] (40 bytes). *)
27
+
(** [endpoint_info_size] is the wire size of {!endpoint_info} (40 bytes). *)
27
28
28
29
(** {1 Control device} *)
29
30
+1
-1
test/test.ml
+1
-1
test/test.ml
+18
-20
test/test_rpmsg.ml
+18
-20
test/test_rpmsg.ml
···
136
136
end
137
137
138
138
let suite =
139
-
[
140
-
( "rpmsg",
141
-
[
142
-
Alcotest.test_case "endpoint_info construction" `Quick
143
-
test_endpoint_info_construction;
144
-
Alcotest.test_case "endpoint_info_size" `Quick test_endpoint_info_size;
145
-
Alcotest.test_case "max_message_size" `Quick test_max_message_size;
146
-
Alcotest.test_case "virtio calculation" `Quick
147
-
test_max_message_size_virtio;
148
-
Alcotest.test_case "send/recv" `Quick test_send_recv;
149
-
Alcotest.test_case "binary" `Quick test_send_recv_binary;
150
-
Alcotest.test_case "max size" `Quick test_send_max_size;
151
-
Alcotest.test_case "single byte" `Quick test_send_recv_single_byte;
152
-
Alcotest.test_case "null payload" `Quick test_send_recv_null_payload;
153
-
Alcotest.test_case "0xFF payload" `Quick test_send_recv_high_bytes;
154
-
Alcotest.test_case "endpoint close" `Quick test_endpoint_close;
155
-
Alcotest.test_case "ctrl open fails on macOS" `Quick
156
-
test_ctrl_open_fails_macos;
157
-
] );
158
-
]
139
+
( "rpmsg",
140
+
[
141
+
Alcotest.test_case "endpoint_info construction" `Quick
142
+
test_endpoint_info_construction;
143
+
Alcotest.test_case "endpoint_info_size" `Quick test_endpoint_info_size;
144
+
Alcotest.test_case "max_message_size" `Quick test_max_message_size;
145
+
Alcotest.test_case "virtio calculation" `Quick
146
+
test_max_message_size_virtio;
147
+
Alcotest.test_case "send/recv" `Quick test_send_recv;
148
+
Alcotest.test_case "binary" `Quick test_send_recv_binary;
149
+
Alcotest.test_case "max size" `Quick test_send_max_size;
150
+
Alcotest.test_case "single byte" `Quick test_send_recv_single_byte;
151
+
Alcotest.test_case "null payload" `Quick test_send_recv_null_payload;
152
+
Alcotest.test_case "0xFF payload" `Quick test_send_recv_high_bytes;
153
+
Alcotest.test_case "endpoint close" `Quick test_endpoint_close;
154
+
Alcotest.test_case "ctrl open fails on macOS" `Quick
155
+
test_ctrl_open_fails_macos;
156
+
] )
+1
-1
test/test_rpmsg.mli
+1
-1
test/test_rpmsg.mli
+21
-27
test/test_wire.ml
+21
-27
test/test_wire.ml
···
205
205
Alcotest.(check int) "release dev cmd" expected 0x4028b504
206
206
207
207
let suite =
208
-
[
209
-
( "wire",
210
-
[
211
-
Alcotest.test_case "endpoint_info size" `Quick test_endpoint_info_size;
212
-
Alcotest.test_case "codec roundtrip" `Quick test_codec_roundtrip;
213
-
Alcotest.test_case "short name" `Quick test_codec_short_name;
214
-
Alcotest.test_case "max name" `Quick test_codec_max_name;
215
-
Alcotest.test_case "name truncation" `Quick test_codec_name_truncation;
216
-
Alcotest.test_case "decode client-sample" `Quick
217
-
test_decode_known_vector;
218
-
Alcotest.test_case "encode client-sample" `Quick
219
-
test_encode_known_vector;
220
-
Alcotest.test_case "decode openamp-demo" `Quick
221
-
test_decode_openamp_vector;
222
-
Alcotest.test_case "encode openamp-demo" `Quick
223
-
test_encode_openamp_vector;
224
-
Alcotest.test_case "ADDR_ANY roundtrip" `Quick test_codec_addr_any;
225
-
Alcotest.test_case "zero addresses" `Quick test_codec_zero_addrs;
226
-
Alcotest.test_case "empty name" `Quick test_codec_empty_name;
227
-
Alcotest.test_case "null terminated" `Quick
228
-
test_codec_name_null_terminated;
229
-
Alcotest.test_case "ioctl CREATE_EPT" `Quick test_ioctl_create_cmd;
230
-
Alcotest.test_case "ioctl DESTROY_EPT" `Quick test_ioctl_destroy_cmd;
231
-
Alcotest.test_case "ioctl CREATE_DEV" `Quick test_ioctl_create_dev_cmd;
232
-
Alcotest.test_case "ioctl RELEASE_DEV" `Quick test_ioctl_release_dev_cmd;
233
-
] );
234
-
]
208
+
( "wire",
209
+
[
210
+
Alcotest.test_case "endpoint_info size" `Quick test_endpoint_info_size;
211
+
Alcotest.test_case "codec roundtrip" `Quick test_codec_roundtrip;
212
+
Alcotest.test_case "short name" `Quick test_codec_short_name;
213
+
Alcotest.test_case "max name" `Quick test_codec_max_name;
214
+
Alcotest.test_case "name truncation" `Quick test_codec_name_truncation;
215
+
Alcotest.test_case "decode client-sample" `Quick test_decode_known_vector;
216
+
Alcotest.test_case "encode client-sample" `Quick test_encode_known_vector;
217
+
Alcotest.test_case "decode openamp-demo" `Quick test_decode_openamp_vector;
218
+
Alcotest.test_case "encode openamp-demo" `Quick test_encode_openamp_vector;
219
+
Alcotest.test_case "ADDR_ANY roundtrip" `Quick test_codec_addr_any;
220
+
Alcotest.test_case "zero addresses" `Quick test_codec_zero_addrs;
221
+
Alcotest.test_case "empty name" `Quick test_codec_empty_name;
222
+
Alcotest.test_case "null terminated" `Quick
223
+
test_codec_name_null_terminated;
224
+
Alcotest.test_case "ioctl CREATE_EPT" `Quick test_ioctl_create_cmd;
225
+
Alcotest.test_case "ioctl DESTROY_EPT" `Quick test_ioctl_destroy_cmd;
226
+
Alcotest.test_case "ioctl CREATE_DEV" `Quick test_ioctl_create_dev_cmd;
227
+
Alcotest.test_case "ioctl RELEASE_DEV" `Quick test_ioctl_release_dev_cmd;
228
+
] )