wasefire-applet-api-desc 0.2.3

// Copyright 2022 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 = "serial".into();
    let items = vec![
        item! {
            /// Reads from USB serial into a buffer.
            ///
            /// Returns the number of bytes read. This function does not block and may return zero.
            fn read "usr" {
                /// Address of the buffer.
                ptr: *mut u8,

                /// Length of the buffer in bytes.
                len: usize,
            } -> usize
        },
        item! {
            /// Writes to USB serial from a buffer.
            ///
            /// Returns the number of bytes written. This function does not block and may return
            /// zero.
            fn write "usw" {
                /// Address of the buffer.
                ptr: *const u8,

                /// Length of the buffer in bytes.
                len: usize,
            } -> usize
        },
        item! {
            /// USB serial events.
            enum Event {
                /// Ready for read.
                Read = 0,
                /// Ready for write.
                Write = 1,
            }
        },
        item! {
            /// Registers a callback when USB serial 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 "use" {
                event: usize,
                handler_func: fn { data: *const void },
                handler_data: *const void,
            } -> ()
        },
        item! {
            /// Unregisters a callback.
            fn unregister "usd" {
                event: usize,
            } -> ()
        },
        item! {
            /// Flushs the USB serial.
            fn flush "usf" {} -> ()
        },
    ];
    Item::Mod(Mod { docs, name, items })
}