aci_setup.h

00001 /* Copyright (c) 2014, Nordic Semiconductor ASA
00002  *
00003  * Permission is hereby granted, free of charge, to any person obtaining a copy
00004  * of this software and associated documentation files (the "Software"), to deal
00005  * in the Software without restriction, including without limitation the rights
00006  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00007  * copies of the Software, and to permit persons to whom the Software is
00008  * furnished to do so, subject to the following conditions:
00009  *
00010  * The above copyright notice and this permission notice shall be included in all
00011  * copies or substantial portions of the Software.
00012  *
00013  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00014  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00015  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00016  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00017  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00018  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00019  * SOFTWARE.
00020  */
00021  
00022  
00023 #ifndef H_ACI_SETUP
00024 #define H_ACI_SETUP
00025 
00026 #define SETUP_SUCCESS                        0
00027 #define SETUP_FAIL_COMMAND_QUEUE_NOT_EMPTY   1
00028 #define SETUP_FAIL_EVENT_QUEUE_NOT_EMPTY     2
00029 #define SETUP_FAIL_TIMEOUT                   3
00030 #define SETUP_FAIL_NOT_SETUP_EVENT           4
00031 #define SETUP_FAIL_NOT_COMMAND_RESPONSE      5
00032 
00033 /** @brief Setup the nRF8001 device
00034  *  @details
00035  *  Performs ACI Setup by transmitting the setup messages generated by nRFgo Studio to the
00036  *  nRF8001, and should be called when the nRF8001 starts or resets.
00037  *  Once all messages are sent, the nRF8001 will send a Device Started Event.
00038  *  The function requires that the Command queue is empty when it is invoked, and will fail
00039  *  otherwise.
00040  *  @returns An integer indicating the reason the function terminated
00041  */
00042 uint8_t do_aci_setup(aci_state_t *aci_stat);
00043 
00044 #endif