Sojus07/hackrf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

libhackrf: document hackrf_transfer struct

Browse Source
This commit is contained in:
Michael Ossmann
2021-11-17 18:38:00 -07:00
parent 80948a2252
commit 0f4f1addd1
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
host/libhackrf/src/hackrf.h
View File

@ -126,13 +126,17 @@ enum sweep_style {
typedef struct hackrf_device hackrf_device;
/**
* USB transfer information passed to RX or TX callback.
* A callback should treat all these fields as read-only except that a TX callback should write to the data buffer.
*/
typedef struct {
hackrf_device* device;
uint8_t* buffer;
int buffer_length;
int valid_length;
void* rx_ctx;
void* tx_ctx;
hackrf_device* device; /**< HackRF USB device for this transfer */
uint8_t* buffer; /**< transfer data buffer */
int buffer_length; /**< length of data buffer in bytes */
int valid_length; /**< number of buffer bytes that were transferred */
void* rx_ctx; /**< RX libusb context */
void* tx_ctx; /**< TX libusb context */
} hackrf_transfer;
typedef struct {