split up crate
This commit is contained in:
17
libcsp/Cargo.toml
Normal file
17
libcsp/Cargo.toml
Normal file
@ -0,0 +1,17 @@
|
||||
[package]
|
||||
name = "libcsp"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
|
||||
description = "Safe and ergonomic Rust API for libcsp on top on libcsp-sys"
|
||||
homepage = "https://egit.irs.uni-stuttgart.de/rust/libcsp-rust"
|
||||
repository = "https://egit.irs.uni-stuttgart.de/rust/libcsp-rust"
|
||||
license = "Apache-2.0"
|
||||
keywords = ["no-std", "space", "aerospace", "ffi", "csp"]
|
||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||
categories = ["aerospace", "external-ffi-bindings", "no-std", "hardware-support", "embedded"]
|
||||
|
||||
[dependencies]
|
||||
bitflags = "2"
|
||||
num_enum = "0.7"
|
||||
libc = "0.2"
|
201
libcsp/LICENSE-APACHE
Normal file
201
libcsp/LICENSE-APACHE
Normal file
@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
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.
|
1
libcsp/NOTICE
Normal file
1
libcsp/NOTICE
Normal file
@ -0,0 +1 @@
|
||||
This software contains code developed at the University of Stuttgart's Institute of Space Systems.
|
20
libcsp/README.md
Normal file
20
libcsp/README.md
Normal file
@ -0,0 +1,20 @@
|
||||
libcsp-rust
|
||||
========
|
||||
|
||||
This crate provides Rust FFI bindings and a Rusty API for the [`libcsp` library](https://github.com/libcsp/libcsp).
|
||||
You can find some more high-level information and examples in the
|
||||
[main workspace](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust).
|
||||
|
||||
The API documentation should provide all additional information required to use this library.
|
||||
|
||||
## Compile-time configuration of the `libcsp-rust` library
|
||||
|
||||
The `libcsp-rust` library requires some compile-time configuration file to be included to work
|
||||
properly. You can see an example version of the file for the workspace
|
||||
[here](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust/src/branch/main/examples/autoconfig.rs).
|
||||
The user has to provide the path to a directory containing this `autoconfig.rs` file using the
|
||||
`CSP_CONFIG_DIR` environmental variable.
|
||||
|
||||
It is recommended to read the [main workspace README](https://egit.irs.uni-stuttgart.de/rust/libcsp-rust)
|
||||
for more information to make the generation and specification of this auto-configuration file
|
||||
as conveniently and easy as possible.
|
512
libcsp/src/lib.rs
Normal file
512
libcsp/src/lib.rs
Normal file
@ -0,0 +1,512 @@
|
||||
#![no_std]
|
||||
|
||||
#[cfg(feature = "alloc")]
|
||||
extern crate alloc;
|
||||
#[cfg(any(feature = "std", test))]
|
||||
extern crate std;
|
||||
|
||||
pub mod config;
|
||||
pub mod ffi;
|
||||
|
||||
use core::time::Duration;
|
||||
|
||||
use num_enum::{IntoPrimitive, TryFromPrimitive};
|
||||
|
||||
use bitflags::bitflags;
|
||||
use ffi::{csp_conn_s, csp_packet_s, csp_socket_s};
|
||||
use libcsp_sys as ffi;
|
||||
|
||||
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
||||
pub enum ReservedPort {
|
||||
Cmp = 0,
|
||||
Ping = 1,
|
||||
Ps = 2,
|
||||
Memfree = 3,
|
||||
Reboot = 4,
|
||||
BufFree = 5,
|
||||
Uptime = 6,
|
||||
}
|
||||
|
||||
#[derive(Debug, PartialEq, Eq, Copy, Clone, TryFromPrimitive, IntoPrimitive)]
|
||||
#[repr(i32)]
|
||||
pub enum CspError {
|
||||
None = 0,
|
||||
NoMem = -1,
|
||||
Inval = -2,
|
||||
TimedOut = -3,
|
||||
Used = -4,
|
||||
NotSup = -5,
|
||||
Busy = -6,
|
||||
Already = -7,
|
||||
Reset = -8,
|
||||
NoBufs = -9,
|
||||
Tx = -10,
|
||||
Driver = -11,
|
||||
Again = -12,
|
||||
NoSys = -38,
|
||||
Hmac = -100,
|
||||
Crc32 = -102,
|
||||
Sfp = -103,
|
||||
}
|
||||
|
||||
/// Listen on all ports, primarily used with [csp_bind]
|
||||
pub const CSP_ANY: u8 = 255;
|
||||
pub const CSP_LOOPBACK: u16 = 0;
|
||||
|
||||
bitflags! {
|
||||
pub struct SocketFlags: u32 {
|
||||
const NONE = 0x0000;
|
||||
/// RDP required.
|
||||
const RDPREQ = 0x0001;
|
||||
/// RDP prohibited.
|
||||
const RDPPROHIB = 0x0002;
|
||||
/// HMAC required
|
||||
const HMACREQ = 0x0004;
|
||||
/// HMAC prohibited.
|
||||
const HMACPROHIB = 0x0008;
|
||||
/// CRC32 required.
|
||||
const CRC32REQ = 0x0040;
|
||||
const CRC32PROHIB = 0x0080;
|
||||
const CONN_LESS = 0x0100;
|
||||
/// Copy opts from incoming packets. Only applies to [csp_sendto_reply]
|
||||
const SAME = 0x8000;
|
||||
|
||||
// The source may set any bits
|
||||
const _ = !0;
|
||||
}
|
||||
}
|
||||
|
||||
bitflags! {
|
||||
pub struct ConnectOpts: u32 {
|
||||
const NONE = SocketFlags::NONE.bits();
|
||||
|
||||
const RDP = SocketFlags::RDPREQ.bits();
|
||||
const NORDP = SocketFlags::RDPPROHIB.bits();
|
||||
const HMAC = SocketFlags::HMACREQ.bits();
|
||||
const NOHMAC = SocketFlags::HMACPROHIB.bits();
|
||||
const CRC32 = SocketFlags::CRC32REQ.bits();
|
||||
const NOCRC32 = SocketFlags::CRC32PROHIB.bits();
|
||||
const SAME = SocketFlags::SAME.bits();
|
||||
|
||||
// The source may set any bits
|
||||
const _ = !0;
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||
#[repr(u8)]
|
||||
pub enum ConnState {
|
||||
Closed = 0,
|
||||
Open = 1,
|
||||
}
|
||||
|
||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||
#[repr(u8)]
|
||||
pub enum ConnType {
|
||||
Client = 0,
|
||||
Server = 1,
|
||||
}
|
||||
|
||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||
#[repr(u32)]
|
||||
pub enum RdpState {
|
||||
Closed = 0,
|
||||
SynSent = 1,
|
||||
SynRcvd = 2,
|
||||
Open = 3,
|
||||
CloseWait = 4,
|
||||
}
|
||||
|
||||
#[derive(Debug, PartialEq, Eq, Copy, Clone, TryFromPrimitive, IntoPrimitive)]
|
||||
#[repr(u8)]
|
||||
pub enum MsgPriority {
|
||||
Critical = 0,
|
||||
High = 1,
|
||||
Normal = 2,
|
||||
Low = 3,
|
||||
}
|
||||
|
||||
pub struct CspPacket(pub csp_packet_s);
|
||||
|
||||
pub struct CspPacketRef(*mut csp_packet_s);
|
||||
|
||||
pub struct CspPacketMut(*mut csp_packet_s);
|
||||
|
||||
impl From<CspPacketMut> for CspPacketRef {
|
||||
fn from(value: CspPacketMut) -> Self {
|
||||
Self(value.0)
|
||||
}
|
||||
}
|
||||
|
||||
impl CspPacketRef {
|
||||
pub fn packet_data(&self) -> &[u8] {
|
||||
unsafe { &(*self.0).packet_data_union.data[..self.packet_length()] }
|
||||
}
|
||||
|
||||
pub fn whole_data(&self) -> &[u8; ffi::CSP_BUFFER_SIZE] {
|
||||
unsafe { &(*self.0).packet_data_union.data }
|
||||
}
|
||||
|
||||
pub fn packet_length(&self) -> usize {
|
||||
unsafe { (*self.0).length.into() }
|
||||
}
|
||||
|
||||
pub fn inner(&self) -> *const csp_packet_s {
|
||||
self.0
|
||||
}
|
||||
}
|
||||
|
||||
pub struct CspPacketRefGuard(Option<CspPacketRef>);
|
||||
|
||||
impl Drop for CspPacketRefGuard {
|
||||
fn drop(&mut self) {
|
||||
if let Some(packet) = self.0.take() {
|
||||
csp_buffer_free(packet)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
impl CspPacketRefGuard {
|
||||
/// Take the packet out of the guard, preventing it from being freed.
|
||||
pub fn take(mut self) -> CspPacketRef {
|
||||
self.0.take().unwrap()
|
||||
}
|
||||
}
|
||||
|
||||
impl AsRef<CspPacketRef> for CspPacketRefGuard {
|
||||
fn as_ref(&self) -> &CspPacketRef {
|
||||
self.0.as_ref().unwrap()
|
||||
}
|
||||
}
|
||||
|
||||
impl CspPacketMut {
|
||||
pub fn packet_data(&self) -> &[u8] {
|
||||
unsafe { &(*self.0).packet_data_union.data[..self.packet_length()] }
|
||||
}
|
||||
|
||||
pub fn whole_data(&self) -> &[u8; ffi::CSP_BUFFER_SIZE] {
|
||||
unsafe { &(*self.0).packet_data_union.data }
|
||||
}
|
||||
|
||||
pub fn packet_length(&self) -> usize {
|
||||
unsafe { (*self.0).length.into() }
|
||||
}
|
||||
|
||||
pub fn inner(&self) -> *const csp_packet_s {
|
||||
self.0
|
||||
}
|
||||
|
||||
pub fn whole_data_mut(&mut self) -> &mut [u8; ffi::CSP_BUFFER_SIZE] {
|
||||
unsafe { &mut (*self.0).packet_data_union.data }
|
||||
}
|
||||
|
||||
pub fn set_data(&mut self, data: &[u8]) -> bool {
|
||||
if data.len() > self.whole_data().len() {
|
||||
return false;
|
||||
}
|
||||
self.whole_data_mut()[0..data.len()].copy_from_slice(data);
|
||||
unsafe {
|
||||
(*self.0).length = data.len() as u16;
|
||||
}
|
||||
true
|
||||
}
|
||||
|
||||
pub fn inner_mut(&self) -> *mut csp_packet_s {
|
||||
self.0
|
||||
}
|
||||
}
|
||||
|
||||
impl CspPacket {
|
||||
pub fn new() -> Self {
|
||||
Self::default()
|
||||
}
|
||||
}
|
||||
|
||||
impl Default for CspPacket {
|
||||
fn default() -> Self {
|
||||
Self(csp_packet_s {
|
||||
packet_info: Default::default(),
|
||||
length: Default::default(),
|
||||
id: Default::default(),
|
||||
next: core::ptr::null_mut(),
|
||||
header: Default::default(),
|
||||
packet_data_union: Default::default(),
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Default)]
|
||||
pub struct CspSocket(pub csp_socket_s);
|
||||
|
||||
impl CspSocket {
|
||||
pub fn inner_as_mut_ptr(&mut self) -> *mut csp_socket_s {
|
||||
&mut self.0
|
||||
}
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_init]. Initialize the CSP stack.
|
||||
///
|
||||
/// # Safety
|
||||
///
|
||||
/// - You must call this function only once.
|
||||
pub unsafe fn csp_init() {
|
||||
// SAFETY: FFI call
|
||||
unsafe {
|
||||
ffi::csp_init();
|
||||
}
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_bind].
|
||||
pub fn csp_bind(socket: &mut CspSocket, port: u8) {
|
||||
// SAFETY: FFI call
|
||||
unsafe {
|
||||
ffi::csp_bind(socket.inner_as_mut_ptr(), port);
|
||||
}
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_listen].
|
||||
pub fn csp_listen(socket: &mut CspSocket, backlog: usize) {
|
||||
// SAFETY: FFI call
|
||||
unsafe {
|
||||
ffi::csp_listen(socket.inner_as_mut_ptr(), backlog);
|
||||
}
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_route_work].
|
||||
pub fn csp_route_work_raw() -> i32 {
|
||||
unsafe { ffi::csp_route_work() }
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_route_work] which also converts errors to the [CspError] type.
|
||||
/// This function will panic if the returned error type is not among the known values of
|
||||
/// [CspError].
|
||||
///
|
||||
/// [csp_route_work_raw] can be used if this is not acceptable.
|
||||
pub fn csp_route_work() -> Result<(), CspError> {
|
||||
let result = unsafe { ffi::csp_route_work() };
|
||||
if result == CspError::None as i32 {
|
||||
return Ok(());
|
||||
}
|
||||
Err(CspError::try_from(result)
|
||||
.unwrap_or_else(|_| panic!("unexpected error value {} from csp_route_work", result)))
|
||||
}
|
||||
|
||||
#[derive(Debug, Copy, Clone)]
|
||||
pub struct CspConnRef(*mut csp_conn_s);
|
||||
|
||||
pub struct CspConnGuard(pub CspConnRef);
|
||||
|
||||
impl Drop for CspConnGuard {
|
||||
fn drop(&mut self) {
|
||||
csp_close(self.0);
|
||||
}
|
||||
}
|
||||
|
||||
impl AsRef<CspConnRef> for CspConnGuard {
|
||||
fn as_ref(&self) -> &CspConnRef {
|
||||
&self.0
|
||||
}
|
||||
}
|
||||
|
||||
impl AsMut<CspConnRef> for CspConnGuard {
|
||||
fn as_mut(&mut self) -> &mut CspConnRef {
|
||||
&mut self.0
|
||||
}
|
||||
}
|
||||
|
||||
pub fn csp_accept_guarded(socket: &mut CspSocket, timeout: Duration) -> Option<CspConnGuard> {
|
||||
Some(CspConnGuard(csp_accept(socket, timeout)?))
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_accept].
|
||||
pub fn csp_accept(socket: &mut CspSocket, timeout: Duration) -> Option<CspConnRef> {
|
||||
let timeout_millis = timeout.as_millis();
|
||||
if timeout_millis > u32::MAX as u128 {
|
||||
return None;
|
||||
}
|
||||
Some(CspConnRef(unsafe {
|
||||
let addr = ffi::csp_accept(socket.inner_as_mut_ptr(), timeout_millis as u32);
|
||||
if addr.is_null() {
|
||||
return None;
|
||||
}
|
||||
addr
|
||||
}))
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_read].
|
||||
pub fn csp_read(conn: &mut CspConnRef, timeout: Duration) -> Option<CspPacketRef> {
|
||||
let timeout_millis = timeout.as_millis();
|
||||
if timeout_millis > u32::MAX as u128 {
|
||||
return None;
|
||||
}
|
||||
let opt_packet = unsafe { ffi::csp_read(conn.0, timeout_millis as u32) };
|
||||
if opt_packet.is_null() {
|
||||
return None;
|
||||
}
|
||||
// SAFETY: FFI pointer.
|
||||
Some(CspPacketRef(unsafe { &mut *opt_packet }))
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_read] which returns a guarded packet reference. This packet
|
||||
/// will cleaned up automatically with [csp_buffer_free] on drop.
|
||||
pub fn csp_read_guarded(conn: &mut CspConnRef, timeout: Duration) -> Option<CspPacketRefGuard> {
|
||||
Some(CspPacketRefGuard(Some(csp_read(conn, timeout)?)))
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_conn_dport].
|
||||
pub fn csp_conn_dport(conn: &CspConnRef) -> i32 {
|
||||
// SAFETY: FFI call.
|
||||
unsafe { ffi::csp_conn_dport(conn.0) }
|
||||
}
|
||||
|
||||
pub fn csp_service_handler(packet: CspPacketRef) {
|
||||
// SAFETY: FFI call.
|
||||
unsafe { ffi::csp_service_handler(&mut *packet.0) }
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_close].
|
||||
pub fn csp_close(conn: CspConnRef) -> i32 {
|
||||
// SAFETY: FFI call.
|
||||
unsafe { ffi::csp_close(conn.0) }
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_ping], returns the result code directly.
|
||||
pub fn csp_ping_raw(node: u16, timeout: Duration, size: usize, opts: SocketFlags) -> i32 {
|
||||
// SAFETY: FFI call.
|
||||
unsafe {
|
||||
ffi::csp_ping(
|
||||
node,
|
||||
timeout.as_millis() as u32,
|
||||
size as u32,
|
||||
opts.bits() as u8,
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||
pub struct PingError;
|
||||
|
||||
/// Rust wrapper for [ffi::csp_ping].
|
||||
pub fn csp_ping(
|
||||
node: u16,
|
||||
timeout: Duration,
|
||||
size: usize,
|
||||
opts: SocketFlags,
|
||||
) -> Result<Duration, PingError> {
|
||||
let result = csp_ping_raw(node, timeout, size, opts);
|
||||
if result < 0 {
|
||||
return Err(PingError);
|
||||
}
|
||||
Ok(Duration::from_millis(result as u64))
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_reboot].
|
||||
pub fn csp_reboot(node: u16) {
|
||||
// SAFETY: FFI call.
|
||||
unsafe { ffi::csp_reboot(node) }
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_connect].
|
||||
pub fn csp_connect(
|
||||
prio: MsgPriority,
|
||||
dst: u16,
|
||||
dst_port: u8,
|
||||
timeout: Duration,
|
||||
opts: ConnectOpts,
|
||||
) -> Option<CspConnRef> {
|
||||
// SAFETY: FFI call.
|
||||
let conn = unsafe {
|
||||
ffi::csp_connect(
|
||||
prio as u8,
|
||||
dst,
|
||||
dst_port,
|
||||
timeout.as_millis() as u32,
|
||||
opts.bits(),
|
||||
)
|
||||
};
|
||||
if conn.is_null() {
|
||||
return None;
|
||||
}
|
||||
// SAFETY: We checked that the pointer is valid.
|
||||
Some(CspConnRef(conn))
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_connect] which returns a guard structure. The connection will be
|
||||
/// be closed automatically when the guard structure is dropped.
|
||||
pub fn csp_connect_guarded(
|
||||
prio: MsgPriority,
|
||||
dst: u16,
|
||||
dst_port: u8,
|
||||
timeout: Duration,
|
||||
opts: ConnectOpts,
|
||||
) -> Option<CspConnGuard> {
|
||||
Some(CspConnGuard(csp_connect(
|
||||
prio, dst, dst_port, timeout, opts,
|
||||
)?))
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_buffer_get].
|
||||
pub fn csp_buffer_get() -> Option<CspPacketMut> {
|
||||
let packet_ref = unsafe {
|
||||
// The size argument is unused
|
||||
ffi::csp_buffer_get(0)
|
||||
};
|
||||
if packet_ref.is_null() {
|
||||
return None;
|
||||
}
|
||||
// SAFETY: We checked that the pointer is valid.
|
||||
Some(CspPacketMut(unsafe { &mut *packet_ref }))
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_send].
|
||||
pub fn csp_send(conn: &mut CspConnRef, packet: impl Into<CspPacketRef>) {
|
||||
// SAFETY: FFI call.
|
||||
unsafe { ffi::csp_send(conn.0, packet.into().0) }
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_conn_print_table].
|
||||
pub fn csp_conn_print_table() {
|
||||
// SAFETY: FFI call.
|
||||
unsafe { ffi::csp_conn_print_table() }
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_iflist_print].
|
||||
pub fn csp_iflist_print() {
|
||||
// SAFETY: FFI call.
|
||||
unsafe { ffi::csp_iflist_print() }
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_buffer_free].
|
||||
pub fn csp_buffer_free(packet: impl Into<CspPacketRef>) {
|
||||
// SAFETY: FFI call and the Rust type system actually ensure the correct type
|
||||
// is free'd here, while also taking the packet by value.
|
||||
unsafe { ffi::csp_buffer_free(packet.into().0 as *mut libc::c_void) }
|
||||
}
|
||||
|
||||
/// Rust wrapper for [ffi::csp_transaction_persistent].
|
||||
///
|
||||
/// # Parameters
|
||||
///
|
||||
/// * `in_len`: Use [None] if the length is unknown, and the expected reply length otherwise.
|
||||
///
|
||||
/// # Returns
|
||||
///
|
||||
/// 1 or reply size on success, 0 otherwise.
|
||||
pub fn csp_transaction_persistent(
|
||||
conn: &mut CspConnRef,
|
||||
timeout: Duration,
|
||||
out_data: &[u8],
|
||||
in_data: &mut [u8],
|
||||
in_len: Option<usize>,
|
||||
) -> i32 {
|
||||
unsafe {
|
||||
ffi::csp_transaction_persistent(
|
||||
conn.0,
|
||||
timeout.as_millis() as u32,
|
||||
out_data.as_ptr() as *const core::ffi::c_void,
|
||||
out_data.len() as i32,
|
||||
in_data.as_ptr() as *mut core::ffi::c_void,
|
||||
in_len.map(|v| v as i32).unwrap_or(-1),
|
||||
)
|
||||
}
|
||||
}
|
8
libcsp/templates/autoconfig.rs
Normal file
8
libcsp/templates/autoconfig.rs
Normal file
@ -0,0 +1,8 @@
|
||||
pub const CSP_CONN_RXQUEUE_LEN: usize = 16;
|
||||
pub const CSP_QFIFO_LEN: usize = 15;
|
||||
pub const CSP_PORT_MAX_BIND: usize = 16;
|
||||
pub const CSP_CONN_MAX: usize = 8;
|
||||
pub const CSP_BUFFER_SIZE: usize = 256;
|
||||
pub const CSP_BUFFER_COUNT: usize = 15;
|
||||
pub const CSP_RDP_MAX_WINDOW: usize = 5;
|
||||
pub const CSP_RTABLE_SIZE: usize = 10;
|
Reference in New Issue
Block a user