Contiki 3.x
adf7023-contiki.h
1 /*
2  * Copyright (c) 2014, Analog Devices, Inc.
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
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  *
14  * 3. Neither the name of the copyright holder nor the names of its
15  * contributors may be used to endorse or promote products derived
16  * from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
22  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
29  * OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 /**
32  * \author Ian Martin <martini@redwirellc.com>
33  */
34 
35 #ifndef __ADF7023_CONTIKI_H__
36 #define __ADF7023_CONTIKI_H__
37 
38 int adf7023_init(void);
39 
40 /* Prepare the radio with a packet to be sent. */
41 int adf7023_prepare(const void *payload, unsigned short payload_len);
42 
43 /* Send the packet that has previously been prepared. */
44 int adf7023_transmit(unsigned short transmit_len);
45 
46 /* Prepare & transmit a packet. */
47 int adf7023_send(const void *payload, unsigned short payload_len);
48 
49 /* Prepare & transmit a packet. */
50 int adf7023_read(void *buf, unsigned short buf_len);
51 
52 /* Perform a Clear-Channel Assessment (CCA) to find out if there is a packet in the air or not. */
53 int adf7023_channel_clear(void);
54 
55 /* Check if the radio driver is currently receiving a packet. */
56 int adf7023_receiving_packet(void);
57 
58 /* Check if the radio driver has just received a packet. */
59 int adf7023_pending_packet(void);
60 
61 /* Turn the radio on. */
62 int adf7023_on(void);
63 
64 /* Turn the radio off. */
65 int adf7023_off(void);
66 
67 #endif /* __ADF7023_CONTIKI_H__ */