Cascoda SDK
Cascoda SDK for building software to run with CA-821x transceivers
ca821x_api_helper.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 CA821X_API_INCLUDE_CA821X_API_HELPER_H_
41 #define CA821X_API_INCLUDE_CA821X_API_HELPER_H_
42 
43 #include "ca821x_api.h"
44 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
61 
75  const struct MLME_BEACON_NOTIFY_indication_pset *aPset);
76 
90  const struct MLME_BEACON_NOTIFY_indication_pset *aPset);
91 
104 uint8_t *MLME_BEACON_NOTIFY_indication_get_sdu(uint8_t *aLength,
105  const struct MLME_BEACON_NOTIFY_indication_pset *aPset);
106 
119 struct PanDescriptor *MLME_SCAN_confirm_get_pandescriptor(uint8_t aIndex, const struct MLME_SCAN_confirm_pset *aPset);
120 
121 #if CASCODA_CA_VER <= 8211
138 
155 
172 #endif // CASCODA_CA_VER <= 8211
173 
174 #ifdef __cplusplus
175 }
176 #endif
177 
182 #endif /* CA821X_API_INCLUDE_CA821X_API_HELPER_H_ */
The main ca821x-api include file.
struct ExtAddr * MLME_BEACON_NOTIFY_indication_get_extaddrs(uint8_t *aLength, const struct MLME_BEACON_NOTIFY_indication_pset *aPset)
Get the ext addresses in the beacon address list.
Definition: ca821x_api_helper.c:65
struct ShortAddr * MLME_BEACON_NOTIFY_indication_get_shortaddrs(uint8_t *aLength, const struct MLME_BEACON_NOTIFY_indication_pset *aPset)
Get the short addresses in the beacon address list.
Definition: ca821x_api_helper.c:52
struct M_KeyUsageDesc * KeyTableEntry_get_keyusagedescs(const struct M_KeyTableEntryFixed *aKte)
Get a pointer to the start of the Key Usage Descriptor list.
Definition: ca821x_api_helper.c:140
uint8_t * MLME_BEACON_NOTIFY_indication_get_sdu(uint8_t *aLength, const struct MLME_BEACON_NOTIFY_indication_pset *aPset)
Get the SDU from a beacon notify indication.
Definition: ca821x_api_helper.c:81
struct PanDescriptor * MLME_SCAN_confirm_get_pandescriptor(uint8_t aIndex, const struct MLME_SCAN_confirm_pset *aPset)
Get an indexed pandescriptor from an MLME-SCAN-confirm of a passive or active scan.
Definition: ca821x_api_helper.c:98
struct M_KeyDeviceDesc * KeyTableEntry_get_keydevicedescs(const struct M_KeyTableEntryFixed *aKte)
Get a pointer to the start of the Key Device Descriptor list.
Definition: ca821x_api_helper.c:130
struct M_KeyIdLookupDesc * KeyTableEntry_get_keyidlookupdescs(const struct M_KeyTableEntryFixed *aKte)
Get a pointer to the start of the Key ID Lookup Descriptor list.
Definition: ca821x_api_helper.c:125
struct SecSpec * MCPS_DATA_indication_get_secspec(const struct MCPS_DATA_indication_pset *aPset)
Get pointer to the security spec of the MCPS Data Indication.
Definition: ca821x_api_helper.c:31
Contains raw extended address.
Definition: mac_messages.h:77
MCPS_DATA_indication parameter set.
Definition: mac_messages.h:384
MLME_BEACON_NOTIFY_indication parameter set.
Definition: mac_messages.h:492
MLME_SCAN_confirm parameter set.
Definition: mac_messages.h:507
Definition: mac_messages.h:874
Definition: mac_messages.h:851
Definition: mac_messages.h:908
Definition: mac_messages.h:893
Describes a discovered PAN.
Definition: mac_messages.h:99
Security specification to be applied to MAC frames.
Definition: mac_messages.h:90
Contains raw little endian short address.
Definition: mac_messages.h:71