Cascoda SDK
Cascoda SDK for building software to run with CA-821x transceivers
ca821x-generic-exchange.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019, Cascoda Ltd.
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  * 1. Redistributions of source code must retain the above copyright
8  * notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  * notice, this list of conditions and the following disclaimer in the
11  * documentation and/or other materials provided with the distribution.
12  * 3. Neither the name of the copyright holder nor the
13  * names of its contributors may be used to endorse or promote products
14  * derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
33 #ifndef CA821X_GENERIC_EXCHANGE_H
34 #define CA821X_GENERIC_EXCHANGE_H
35 
37 
38 #define MAX_BUF_SIZE 256
39 
45 ca_error init_generic(struct ca821x_dev *pDeviceRef);
46 
52 ca_error deinit_generic(struct ca821x_dev *pDeviceRef);
53 
60 ca_error exchange_handle_error(ca_error error, struct ca821x_dev *pDeviceRef);
61 
67 void *ca821x_io_worker(void *arg);
68 
80 ca_error ca821x_exchange_commands(const uint8_t *buf, size_t len, uint8_t *response, struct ca821x_dev *pDeviceRef);
81 
82 #endif
ca_error exchange_handle_error(ca_error error, struct ca821x_dev *pDeviceRef)
Attempt to recover from an exchange error silently.
Definition: ca821x-generic-exchange.c:318
ca_error ca821x_exchange_commands(const uint8_t *buf, size_t len, uint8_t *response, struct ca821x_dev *pDeviceRef)
Handle an exchange with the ca821x.
Definition: ca821x-generic-exchange.c:418
void * ca821x_io_worker(void *arg)
io worker thread function.
Definition: ca821x-generic-exchange.c:393
ca_error init_generic(struct ca821x_dev *pDeviceRef)
Initialise the generic part of a pDeviceRef.
Definition: ca821x-generic-exchange.c:181
ca_error deinit_generic(struct ca821x_dev *pDeviceRef)
Deinitialise an initialised pDeviceRef struct.
Definition: ca821x-generic-exchange.c:212
Various types used by the cascoda posix api.
ca_error
Cascoda error type.
Definition: ca821x_error.h:51
CA-821x Device reference struct.
Definition: ca821x_api.h:123