d3xx 0.0.3

Rust bindings for the FTDI D3XX library
Documentation 
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241

//! Miscellaneous utility functions.
//!
//! This module contains functions which are used internally by the crate, but are not
//! part of the public API. These functions may be changed or removed at any time.

use super::*;
use crate::{try_d3xx, D3xxError};

/// Write to a pipe synchronously.
///
/// If the operation fails it is the responsibility of the caller to
/// abort any ongoing transfers for the pipe.
///
/// On success the number of bytes written is returned.
///
/// # Panics
///
/// Panics if `buf.len()` exceeds [`ULONG::MAX`]
#[cfg(windows)]
pub(crate) fn write_pipe(handle: FT_HANDLE, pipe: u8, buf: &[u8]) -> Result<usize> {
    let mut bytes_written: ULONG = 0;
    try_d3xx!(unsafe {
        FT_WritePipe(
            handle,
            pipe,
            buf.as_ptr().cast_mut(),
            ULONG::try_from(buf.len()).expect("buffer length exceeds ULONG::MAX"),
            std::ptr::addr_of_mut!(bytes_written),
            std::ptr::null_mut(),
        )
    })?;
    Ok(bytes_written as usize)
}

/// Write to a pipe synchronously.
///
/// If the operation fails it is the responsibility of the caller to
/// abort any ongoing transfers for the pipe.
///
/// On success the number of bytes written is returned.
///
/// # Panics
///
/// Panics if `buf.len()` exceeds [`ULONG::MAX`]
#[cfg(not(windows))]
pub(crate) fn write_pipe(handle: FT_HANDLE, pipe: u8, buf: &[u8]) -> Result<usize> {
    let mut bytes_written: ULONG = 0;
    try_d3xx!(unsafe {
        FT_WritePipe(
            handle,
            pipe,
            buf.as_ptr().cast_mut(),
            ULONG::try_from(buf.len()).expect("buffer length exceeds ULONG::MAX"),
            std::ptr::addr_of_mut!(bytes_written),
            0,
        )
    })?;
    Ok(bytes_written as usize)
}

/// Asynchronous write to the specified pipe.
///
/// If the operation fails it is the responsibility of the user to
/// abort any ongoing transfers for the pipe.
///
/// On success the number of bytes written is returned.
///
/// # Panics
///
/// Panics if `buf.len()` exceeds [`ULONG::MAX`]
#[cfg(windows)]
pub(crate) fn write_pipe_async(
    handle: FT_HANDLE,
    pipe: u8,
    buf: &[u8],
    overlapped: &mut _OVERLAPPED,
) -> Result<()> {
    let mut bytes_written: ULONG = 0;
    ignore_io_pending(try_d3xx!(unsafe {
        FT_WritePipe(
            handle,
            pipe,
            buf.as_ptr().cast_mut(),
            ULONG::try_from(buf.len()).expect("buffer length exceeds ULONG::MAX"),
            std::ptr::addr_of_mut!(bytes_written),
            overlapped as *mut _OVERLAPPED,
        )
    }))
}

/// Asynchronous write to the specified pipe.
///
/// If the operation fails it is the responsibility of the user to
/// abort any ongoing transfers for the pipe.
///
/// On success the number of bytes written is returned.
///
/// # Panics
///
/// Panics if `buf.len()` exceeds [`ULONG::MAX`]
#[cfg(not(windows))]
pub fn write_pipe_async(
    handle: FT_HANDLE,
    pipe: u8,
    buf: &[u8],
    overlapped: &mut _OVERLAPPED,
) -> Result<()> {
    let mut bytes_written: ULONG = 0;
    ignore_io_pending(try_d3xx!(unsafe {
        FT_WritePipeAsync(
            handle,
            pipe as u8,
            buf.as_ptr().cast_mut(),
            ULONG::try_from(buf.len()).expect("buffer length exceeds ULONG::MAX"),
            std::ptr::addr_of_mut!(bytes_written),
            overlapped as *mut _OVERLAPPED,
        )
    }))
}

/// Read from a pipe synchronously.
///
/// If the operation fails it is the responsibility of the user to
/// abort any ongoing transfers for the pipe.
///
/// On success the number of bytes read is returned.
///
/// # Panics
///
/// Panics if `buf.len()` exceeds [`ULONG::MAX`]
#[cfg(windows)]
pub(crate) fn read_pipe(handle: FT_HANDLE, pipe: u8, buf: &mut [u8]) -> Result<usize> {
    let mut bytes_read: ULONG = 0;
    try_d3xx!(unsafe {
        FT_ReadPipe(
            handle,
            pipe,
            buf.as_mut_ptr().cast(),
            ULONG::try_from(buf.len()).expect("buffer length exceeds ULONG::MAX"),
            std::ptr::addr_of_mut!(bytes_read),
            std::ptr::null_mut(),
        )
    })?;
    Ok(bytes_read as usize)
}

/// Read from a pipe synchronously.
///
/// If the operation fails it is the responsibility of the user to
/// abort any ongoing transfers for the pipe.
///
/// On success the number of bytes read is returned.
///
/// # Panics
///
/// Panics if `buf.len()` exceeds [`ULONG::MAX`]
#[cfg(not(windows))]
pub(crate) fn read_pipe(handle: FT_HANDLE, pipe: u8, buf: &mut [u8]) -> Result<usize> {
    let mut bytes_read: ULONG = 0;
    try_d3xx!(unsafe {
        FT_ReadPipe(
            handle,
            pipe as u8,
            buf.as_mut_ptr().cast(),
            ULONG::try_from(buf.len()).expect("buffer length exceeds ULONG::MAX"),
            std::ptr::addr_of_mut!(bytes_read),
            0,
        )
    })?;
    Ok(bytes_read as usize)
}

/// Asynchronous read from the specified pipe.
///
/// If the operation fails it is the responsibility of the user to
/// abort any ongoing transfers for the pipe.
///
/// On success the number of bytes read is returned.
///
/// # Panics
///
/// Panics if `buf.len()` exceeds [`ULONG::MAX`]
#[cfg(windows)]
pub(crate) fn read_pipe_async(
    handle: FT_HANDLE,
    pipe: u8,
    buf: &mut [u8],
    overlapped: &mut _OVERLAPPED,
) -> Result<()> {
    let mut bytes_read: ULONG = 0;
    ignore_io_pending(try_d3xx!(unsafe {
        FT_ReadPipe(
            handle,
            pipe,
            buf.as_mut_ptr().cast(),
            ULONG::try_from(buf.len()).expect("buffer length exceeds ULONG::MAX"),
            std::ptr::addr_of_mut!(bytes_read),
            overlapped as *mut _OVERLAPPED,
        )
    }))
}

/// Asynchronous read from the specified pipe.
///
/// If the operation fails it is the responsibility of the user to
/// abort any ongoing transfers for the pipe.
///
/// On success the number of bytes read is returned.
///
/// # Panics
///
/// Panics if `buf.len()` exceeds [`ULONG::MAX`]
#[cfg(not(windows))]
pub fn read_pipe_async(
    handle: FT_HANDLE,
    pipe: u8,
    buf: &mut [u8],
    overlapped: &mut _OVERLAPPED,
) -> Result<()> {
    let mut bytes_read: ULONG = 0;
    ignore_io_pending(try_d3xx!(unsafe {
        FT_ReadPipeAsync(
            handle,
            pipe,
            buf.as_mut_ptr().cast(),
            ULONG::try_from(buf.len()).expect("buffer length exceeds ULONG::MAX"),
            std::ptr::addr_of_mut!(bytes_read),
            overlapped as *mut _OVERLAPPED,
        )
    }))
}

/// Filter out `D3xxError::IoPending` errors, since they are expected for
/// asynchronous I/O operations.
#[inline]
fn ignore_io_pending(res: Result<()>) -> Result<()> {
    match res {
        Err(D3xxError::IoPending) => Ok(()),
        x => x,
    }
}