Home | History | Annotate | Download | only in nrf8001
      1 /* Copyright (c) 2014, Nordic Semiconductor ASA
      2  *
      3  * Permission is hereby granted, free of charge, to any person obtaining a copy
      4  * of this software and associated documentation files (the "Software"), to deal
      5  * in the Software without restriction, including without limitation the rights
      6  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
      7  * copies of the Software, and to permit persons to whom the Software is
      8  * furnished to do so, subject to the following conditions:
      9  *
     10  * The above copyright notice and this permission notice shall be included in all
     11  * copies or substantial portions of the Software.
     12  *
     13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
     14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
     15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
     16  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
     17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
     18  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
     19  * SOFTWARE.
     20  */
     21 
     22 /**
     23  * @file
     24  * @brief ACI setup functions
     25  * @ingroup aci
     26  */
     27 
     28 #ifndef H_ACI_SETUP
     29 #define H_ACI_SETUP
     30 
     31 #define SETUP_SUCCESS                        0
     32 #define SETUP_FAIL_COMMAND_QUEUE_NOT_EMPTY   1
     33 #define SETUP_FAIL_EVENT_QUEUE_NOT_EMPTY     2
     34 #define SETUP_FAIL_TIMEOUT                   3
     35 #define SETUP_FAIL_NOT_SETUP_EVENT           4
     36 #define SETUP_FAIL_NOT_COMMAND_RESPONSE      5
     37 
     38 bool aci_setup_fill(aci_state_t *aci_stat, uint8_t *num_cmd_offset);
     39 /** @brief Setup the nRF8001 device
     40  *  @details
     41  *  Performs ACI Setup by transmitting the setup messages generated by nRFgo Studio to the
     42  *  nRF8001, and should be called when the nRF8001 starts or resets.
     43  *  Once all messages are sent, the nRF8001 will send a Device Started Event.
     44  *  The function requires that the Command queue is empty when it is invoked, and will fail
     45  *  otherwise.
     46  *  @returns An integer indicating the reason the function terminated
     47  */
     48 uint8_t do_aci_setup(aci_state_t *aci_stat);
     49 
     50 #endif
     51