Cascoda SDK
Cascoda SDK for building software to run with CA-821x transceivers
usb-exchange.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016, Cascoda
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its contributors
16  * may be used to endorse or promote products derived from this software without
17  * specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
36 #ifndef USB_EXCHANGE_H
37 #define USB_EXCHANGE_H
38 
40 #include "ca821x_api.h"
41 #define TEST_ENABLE 1
42 
44 {
48 };
49 
75  const char *path,
76  struct ca821x_dev *pDeviceRef,
77  char *serial_num);
78 
86 void usb_exchange_deinit(struct ca821x_dev *pDeviceRef);
87 
97 int usb_exchange_reset(unsigned long resettime, struct ca821x_dev *pDeviceRef);
98 
110 ca_error usb_exchange_enumerate(util_device_found aCallback, void *aContext);
111 
112 #ifdef TEST_ENABLE
114 void test_frag_loopback();
115 #endif
116 
117 #endif
Various types used by the cascoda posix api.
void(* util_device_found)(struct ca_device_info *aDeviceInfo, void *aContext)
Function type for handling enumerated devices when finding them.
Definition: ca821x-types.h:241
ca_error(* ca821x_errorhandler)(ca_error error, struct ca821x_dev *pDeviceRef)
Error callback.
Definition: ca821x-types.h:61
The main ca821x-api include file.
ca_error
Cascoda error type.
Definition: ca821x_error.h:51
CA-821x Device reference struct.
Definition: ca821x_api.h:123
void usb_exchange_deinit(struct ca821x_dev *pDeviceRef)
Deinitialise the usb exchange, so that it can be reinitialised by another process,...
Definition: usb-exchange.c:769
int usb_exchange_reset(unsigned long resettime, struct ca821x_dev *pDeviceRef)
Send a hard reset to the ca821x.
Definition: usb-exchange.c:861
usb_exchange_errors
Definition: usb-exchange.h:44
@ usb_exchange_err_generic
Definition: usb-exchange.h:47
@ usb_exchange_err_ca821x
ca821x error - ca821x has been reset
Definition: usb-exchange.h:46
@ usb_exchange_err_usb
Usb error - probably device removed and going to have to crash safely.
Definition: usb-exchange.h:45
ca_error usb_exchange_enumerate(util_device_found aCallback, void *aContext)
Function to enumerate all of the USB connected devices, calling aCallback with a struct describing ea...
Definition: usb-exchange.c:789
void test_frag_loopback()
Run to test fragmentation.
Definition: usb-exchange.c:194
ca_error usb_exchange_init(ca821x_errorhandler callback, const char *path, struct ca821x_dev *pDeviceRef, char *serial_num)
Initialise the usb exchange.
Definition: usb-exchange.c:646