src/nrf8001/aci_setup.h

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