Cascoda SDK
Cascoda SDK for building software to run with CA-821x transceivers
kernel-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 KERNEL_EXCHANGE_H
37 #define KERNEL_EXCHANGE_H
38 
40 #include "ca821x_api.h"
41 
55 ca_error kernel_exchange_init(ca821x_errorhandler callback, struct ca821x_dev *pDeviceRef);
56 
64 void kernel_exchange_deinit(struct ca821x_dev *pDeviceRef);
65 
75 int kernel_exchange_reset(unsigned long resettime, struct ca821x_dev *pDeviceRef);
76 
88 ca_error kernel_exchange_enumerate(util_device_found aCallback, void *aContext);
89 
90 #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_error kernel_exchange_init(ca821x_errorhandler callback, struct ca821x_dev *pDeviceRef)
Initialise the kernel exchange, using the supplied errorhandling callback to report any errors back t...
Definition: kernel-exchange.c:185
ca_error kernel_exchange_enumerate(util_device_found aCallback, void *aContext)
Function to enumerate all of the kernel devices configured (currently max single device per system),...
Definition: kernel-exchange.c:271
int kernel_exchange_reset(unsigned long resettime, struct ca821x_dev *pDeviceRef)
Send a hard reset to the ca8210.
Definition: kernel-exchange.c:265
void kernel_exchange_deinit(struct ca821x_dev *pDeviceRef)
Deinitialise the kernel exchange, so that it can be reinitialised by another process,...
Definition: kernel-exchange.c:241
CA-821x Device reference struct.
Definition: ca821x_api.h:123