CCSDS AOS (Advanced Orbiting Systems) Transfer Frame for satellite downlinks
aos: add Wire field docs, rename aos_data_size (merlint E330/E400)
- Document all Wire parameter and field values in aos.mli
- Rename aos_data_size → data_size (redundant module prefix)
+24
-2
+2
-2
lib/aos.ml
+2
-2
lib/aos.ml
···
245
245
Wire.Field.v "insert_zone"
246
246
(Wire.byte_array ~size:(Wire.Param.expr p_insert_zone_len))
247
247
248
-
let aos_data_size =
248
+
let data_size =
249
249
Wire.Expr.(
250
250
Wire.Param.expr p_frame_len
251
251
- Wire.int header_len
···
253
253
- (Wire.int 4 * Wire.Param.expr p_expect_ocf)
254
254
- (Wire.int 2 * Wire.Param.expr p_expect_fecf))
255
255
256
-
let w_aos_data = Wire.Field.v "data" (Wire.byte_array ~size:aos_data_size)
256
+
let w_aos_data = Wire.Field.v "data" (Wire.byte_array ~size:data_size)
257
257
258
258
let w_aos_ocf =
259
259
Wire.Field.v "ocf"
+22
lib/aos.mli
+22
lib/aos.mli
···
231
231
(** Full frame Wire codec. *)
232
232
233
233
val p_frame_len : (int, Wire.Param.input) Wire.Param.t
234
+
(** Frame length parameter. *)
235
+
234
236
val p_insert_zone_len : (int, Wire.Param.input) Wire.Param.t
237
+
(** Insert zone length parameter. *)
238
+
235
239
val p_expect_ocf : (int, Wire.Param.input) Wire.Param.t
240
+
(** Operational control field presence parameter. *)
241
+
236
242
val p_expect_fecf : (int, Wire.Param.input) Wire.Param.t
243
+
(** Frame error control field presence parameter. *)
237
244
238
245
(** Wire struct definition for an AOS header. *)
239
246
···
245
252
{!Wire.Codec.set} and batch bitfield reads via {!Wire.Codec.bitfield}. *)
246
253
247
254
val f_version : (int, packed_header) Wire.Codec.field
255
+
(** Version number field (2 bits). *)
256
+
248
257
val f_scid : (int, packed_header) Wire.Codec.field
258
+
(** Spacecraft identifier field (8 bits). *)
259
+
249
260
val f_vcid : (int, packed_header) Wire.Codec.field
261
+
(** Virtual channel identifier field (6 bits). *)
262
+
250
263
val f_vcfc : (int, packed_header) Wire.Codec.field
264
+
(** Virtual channel frame count field (24 bits). *)
265
+
251
266
val f_replay_flag : (bool, packed_header) Wire.Codec.field
267
+
(** Replay flag field. *)
268
+
252
269
val f_vc_count_flag : (bool, packed_header) Wire.Codec.field
270
+
(** Virtual channel frame count usage flag. *)
271
+
253
272
val f_spare : (int, packed_header) Wire.Codec.field
273
+
(** Spare field (reserved). *)
274
+
254
275
val f_vc_count_cycle : (int, packed_header) Wire.Codec.field
276
+
(** Virtual channel frame count cycle field. *)
255
277
256
278
(** {1 Wire Parse/Encode} *)
257
279