Cascoda SDK
Cascoda SDK for building software to run with CA-821x transceivers
cascoda_wait.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  */
40 #ifndef CASCODA_WAIT_H
41 #define CASCODA_WAIT_H
42 
43 #include "ca821x_api.h"
44 #include "mac_messages.h"
45 
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49 
55 void WAIT_ms(uint32_t ticks);
56 
83 ca_error WAIT_Callback(uint8_t aCommandId, uint32_t aTimeoutMs, void *aCallbackContext, struct ca821x_dev *pDeviceRef);
84 
116 ca_error WAIT_CallbackSwap(uint8_t aCommandId,
117  ca821x_generic_callback aCallback,
118  uint32_t aTimeoutMs,
119  void *aCallbackContext,
120  struct ca821x_dev *pDeviceRef);
121 
132 void *WAIT_GetContext(void);
133 
134 #ifdef __cplusplus
135 }
136 #endif
137 
138 #endif //CASCODA_WAIT_H
139 
The main ca821x-api include file.
void * WAIT_GetContext(void)
Get the callback context from within a callback being waited for.
Definition: cascoda_wait.c:146
ca_error WAIT_CallbackSwap(uint8_t aCommandId, ca821x_generic_callback aCallback, uint32_t aTimeoutMs, void *aCallbackContext, struct ca821x_dev *pDeviceRef)
Wait for an asynchronous callback to be triggered, with a given callback swapped in.
Definition: cascoda_wait.c:122
ca_error WAIT_Callback(uint8_t aCommandId, uint32_t aTimeoutMs, void *aCallbackContext, struct ca821x_dev *pDeviceRef)
Wait for an asynchronous callback to be triggered.
Definition: cascoda_wait.c:106
void WAIT_ms(uint32_t ticks)
Wait for a given number of milliseconds.
ca_error
Cascoda error type.
Definition: ca821x_error.h:51
ca_error(* ca821x_generic_callback)(void *params, struct ca821x_dev *pDeviceRef)
Definition: mac_messages.h:969
Definitions relating to MLME and MCPS API messages.
CA-821x Device reference struct.
Definition: ca821x_api.h:123