visus
/
framework-arduinoteensy-cxx20
Obserwuj 1
Polub 0
Forkuj 0
Kod Zgłoszenia 0 Oczekujące zmiany 0 Wydania 0 Wiki Aktywność
PlatformIO package of the Teensy core framework compatible with GCC 10 & C++20
Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
4 Commity
1 Gałąź
Drzewo: 16a0c39090
Gałęzie Tagi
${ item.name }
Utwórz gałąź ${ searchTerm }
z '16a0c39090'
${ noResults }
framework-arduinoteensy-cxx20/libraries/Adafruit_nRF8001/utility/acilib_if.h

464 lines
17KB
Czysty Wina Historia 

  1. /* Copyright (c) 2010 Nordic Semiconductor. All Rights Reserved.

  2.  *

  3.  * The information contained herein is property of Nordic Semiconductor ASA.

  4.  * Terms and conditions of usage are described in detail in NORDIC

  5.  * SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.

  6.  *

  7.  * Licensees are granted free, non-transferable use of the information. NO

  8.  * WARRANTY of ANY KIND is provided. This heading must NOT be removed from

  9.  * the file.

  10.  *

  11.  * $LastChangedRevision$

  12.  */

  13. 

  14. /**

  15.  * @file

  16.  *

  17.  * @ingroup group_acilib

  18.  *

  19.  * @brief Prototypes for the acilib interfaces.

  20.  */

  21. 

  22. #ifndef _acilib_IF_H_

  23. #define _acilib_IF_H_

  24. 

  25. /** @brief Encode the ACI message for set test mode command

  26.  *

  27.  *  @param[in,out]  buffer      Pointer to ACI message buffer

  28.  *  @param[in]      test_mode   Pointer to the test mode in ::aci_cmd_params_test_t

  29.  *

  30.  *  @return         None

  31.  */

  32. void acil_encode_cmd_set_test_mode(uint8_t *buffer, aci_cmd_params_test_t *p_aci_cmd_params_test);

  33. 

  34. /** @brief Encode the ACI message for sleep command

  35.  *

  36.  *  @param[in,out]  buffer      Pointer to ACI message buffer

  37.  *

  38.  *  @return         None

  39.  */

  40. void acil_encode_cmd_sleep(uint8_t *buffer);

  41. 

  42. /** @brief Encode the ACI message for get device version

  43.  *

  44.  *  @param[in,out]  buffer      Pointer to ACI message buffer

  45.  *

  46.  *  @return         None

  47.  */

  48. void acil_encode_cmd_get_device_version(uint8_t *buffer);

  49. 

  50. /** @brief Encode the ACI message for set local data

  51.  *

  52.  *  @param[in,out]  buffer                           Pointer to ACI message buffer

  53.  *  @param[in]      p_aci_cmd_params_set_local_data  Pointer to the local data parameters in ::aci_cmd_params_set_local_data_t

  54.  *  @param[in]      data_size                        Size of data message

  55.  *

  56.  *  @return         None

  57.  */

  58. void acil_encode_cmd_set_local_data(uint8_t *buffer, aci_cmd_params_set_local_data_t *p_aci_cmd_params_set_local_data, uint8_t data_size);

  59. 

  60. /** @brief Encode the ACI message to connect

  61.  *

  62.  *  @param[in,out]  buffer                    Pointer to ACI message buffer

  63.  *  @param[in]      p_aci_cmd_params_connect  Pointer to the run parameters in ::aci_cmd_params_connect_t

  64.  *

  65.  *  @return         None

  66.  */

  67. void acil_encode_cmd_connect(uint8_t *buffer, aci_cmd_params_connect_t *p_aci_cmd_params_connect);

  68. 

  69. /** @brief Encode the ACI message to bond

  70.  *

  71.  *  @param[in,out]  buffer                 Pointer to ACI message buffer

  72.  *  @param[in]      p_aci_cmd_params_bond  Pointer to the run parameters in ::aci_cmd_params_bond_t

  73.  *

  74.  *  @return         None

  75.  */

  76. void acil_encode_cmd_bond(uint8_t *buffer, aci_cmd_params_bond_t *p_aci_cmd_params_bond);

  77. 

  78. /** @brief Encode the ACI message to disconnect

  79.  *

  80.  *  @param[in,out]  buffer                       Pointer to ACI message buffer

  81.  *  @param[in]      p_aci_cmd_params_disconnect  Pointer to the run parameters in ::aci_cmd_params_disconnect_t

  82.  *

  83.  *  @return         None

  84.  */

  85. void acil_encode_cmd_disconnect(uint8_t *buffer, aci_cmd_params_disconnect_t *p_aci_cmd_params_disconnect);

  86. 

  87. /** @brief Encode the ACI message to baseband reset

  88.  *

  89.  *  @param[in,out]  buffer        Pointer to ACI message buffer

  90.  *

  91.  *  @return         None

  92.  */

  93.  void acil_encode_baseband_reset(uint8_t *buffer);

  94. 

  95.  /** @brief Encode the ACI message for Directed Advertising

  96.  *

  97.  *  @param[in,out]  buffer        Pointer to ACI message buffer

  98.  *

  99.  *  @return         None

  100.  */

  101.  void acil_encode_direct_connect(uint8_t *buffer);

  102. 

  103. /** @brief Encode the ACI message to wakeup

  104.  *

  105.  *  @param[in,out]  buffer        Pointer to ACI message buffer

  106.  *

  107.  *  @return         None

  108.  */

  109. void acil_encode_cmd_wakeup(uint8_t *buffer);

  110. 

  111. /** @brief Encode the ACI message for set radio Tx power

  112.  *

  113.  *  @param[in,out]  buffer                         Pointer to ACI message buffer

  114.  *  @param[in]      p_aci_cmd_params_set_tx_power  Pointer to the set Tx power parameters in ::aci_cmd_params_set_tx_power_t

  115.  *

  116.  *  @return         None

  117.  */

  118. void acil_encode_cmd_set_radio_tx_power(uint8_t *buffer, aci_cmd_params_set_tx_power_t *p_aci_cmd_params_set_tx_power);

  119. 

  120. /** @brief Encode the ACI message for get device address

  121.  *

  122.  *  @param[in,out]  buffer            Pointer to ACI message buffer

  123.  *

  124.  *  @return         None

  125.  */

  126. void acil_encode_cmd_get_address(uint8_t *buffer);

  127. 

  128. /** @brief Encode the ACI message for send data

  129.  *

  130.  *  @param[in,out]  buffer                        Pointer to ACI message buffer

  131.  *  @param[in]      p_aci_cmd_params_send_data_t  Pointer to the data parameters in ::aci_cmd_params_send_data_t

  132.  *  @param[in]      data_size                     Size of data message

  133.  *

  134.  *  @return         None

  135.  */

  136. void acil_encode_cmd_send_data(uint8_t *buffer, aci_cmd_params_send_data_t *p_aci_cmd_params_send_data_t, uint8_t data_size);

  137. 

  138. /** @brief Encode the ACI message for request data

  139.  *

  140.  *  @param[in,out]  buffer                          Pointer to ACI message buffer

  141.  *  @param[in]      p_aci_cmd_params_request_data   Pointer to the request data parameters in ::aci_cmd_params_request_data_t

  142.  *

  143.  *  @return         None

  144.  */

  145. void acil_encode_cmd_request_data(uint8_t *buffer, aci_cmd_params_request_data_t *p_aci_cmd_params_request_data);

  146. 

  147. /** @brief Encode the ACI message for open remote pipe

  148.  *

  149.  *  @param[in,out]  buffer                              Pointer to ACI message buffer

  150.  *  @param[in]      p_aci_cmd_params_open_remote_pipe   Pointer to the dynamic data parameters in ::aci_cmd_params_open_remote_pipe_t

  151.  *

  152.  *  @return         None

  153.  */

  154. void acil_encode_cmd_open_remote_pipe(uint8_t *buffer, aci_cmd_params_open_remote_pipe_t *p_aci_cmd_params_open_remote_pipe);

  155. 

  156. /** @brief Encode the ACI message for close remote pipe

  157.  *

  158.  *  @param[in,out]  buffer                              Pointer to ACI message buffer

  159.  *  @param[in]      p_aci_cmd_params_close_remote_pipe   Pointer to the dynamic data parameters in ::aci_cmd_params_close_remote_pipe_t

  160.  *

  161.  *  @return         None

  162.  */

  163. void acil_encode_cmd_close_remote_pipe(uint8_t *buffer, aci_cmd_params_close_remote_pipe_t *p_aci_cmd_params_close_remote_pipe);

  164. 

  165. /** @brief Encode the ACI message for echo message

  166.  *

  167.  *  @param[in,out]  buffer             Pointer to ACI message buffer

  168.  *  @param[in]      p_cmd_params_echo  Pointer to the dynamic data parameters in ::aci_cmd_params_echo_t

  169.  *  @param[in]      msg_size           Size of the message

  170.  *

  171.  *  @return         None

  172.  */

  173. void acil_encode_cmd_echo_msg(uint8_t *buffer, aci_cmd_params_echo_t *p_cmd_params_echo, uint8_t msg_size);

  174. 

  175. /** @brief Encode the ACI message to battery level

  176.  *

  177.  *  @param[in,out]  buffer  Pointer to ACI message buffer

  178.  *

  179.  *  @return         None

  180.  */

  181. void acil_encode_cmd_battery_level(uint8_t *buffer);

  182. 

  183. /** @brief Encode the ACI message to temparature

  184.  *

  185.  *  @param[in,out]  buffer  Pointer to ACI message buffer

  186.  *

  187.  *  @return         None

  188.  */

  189. void acil_encode_cmd_temparature(uint8_t *buffer);

  190. 

  191. /** @brief Encode the ACI message to read dynamic data

  192.  *

  193.  *  @param[in,out]  buffer  Pointer to ACI message buffer

  194.  *

  195.  *  @return         None

  196.  */

  197. void acil_encode_cmd_read_dynamic_data(uint8_t *buffer);

  198. 

  199. /** @brief Encode the ACI message to change timing request

  200.  *

  201.  *  @param[in,out]  buffer  Pointer to ACI message buffer

  202.  *  @param[in]      p_aci_cmd_params_change_timing  Pointer to the change timing parameters in ::aci_cmd_params_change_timing_t

  203.  *

  204.  *  @return         None

  205.  */

  206. void acil_encode_cmd_change_timing_req(uint8_t *buffer, aci_cmd_params_change_timing_t *p_aci_cmd_params_change_timing);

  207. 

  208. /** @brief Encode the ACI message to change timing request using the timing parameters from GAP PPCP

  209.  *

  210.  *  @param[in,out]  buffer  Pointer to ACI message buffer

  211.  *  @param[in]      p_aci_cmd_params_change_timing  Pointer to the change timing parameters in ::aci_cmd_params_change_timing_t

  212.  *

  213.  *  @return         None

  214.  */

  215. void acil_encode_cmd_change_timing_req_GAP_PPCP(uint8_t *buffer);

  216. 

  217. 

  218. /** @brief Encode the ACI message for write dynamic data

  219.  *

  220.  *  @param[in,out]  buffer                          Pointer to ACI message buffer

  221.  *  @param[in]      seq_no                          Sequence number of the dynamic data (as received in the response to @c Read Dynamic Data)

  222.  *  @param[in]      dynamic_data                    Pointer to the dynamic data

  223.  *  @param[in]      dynamic_data_size               Size of dynamic data

  224.  *

  225.  *  @return         None

  226.  */

  227. void acil_encode_cmd_write_dynamic_data(uint8_t *buffer, uint8_t seq_no, uint8_t* dynamic_data, uint8_t dynamic_data_size);

  228. 

  229. /** @brief Encode the ACI message to send data acknowledgement

  230.  *

  231.  *  @param[in,out]  buffer  Pointer to ACI message buffer

  232.  *  @param[in]      pipe_number Pipe number for which the ack is to be sent

  233.  *

  234.  *  @return         None

  235.  */

  236. void acil_encode_cmd_send_data_ack(uint8_t *buffer, const uint8_t pipe_number);

  237. 

  238. /** @brief Encode the ACI message to send negative acknowledgement

  239.  *

  240.  *  @param[in,out]  buffer  Pointer to ACI message buffer

  241.  *  @param[in]    pipe_number Pipe number for which the nack is to be sent

  242.  *  @param[in]    error_code Error code that has to be sent in the NACK

  243.  *

  244.  *  @return         None

  245.  */

  246. void acil_encode_cmd_send_data_nack(uint8_t *buffer, const uint8_t pipe_number,const uint8_t error_code);

  247. 

  248. /** @brief Encode the ACI message to set the application latency

  249.  *

  250.  *  @param[in,out]  buffer  Pointer to ACI message buffer

  251.  *  @param[in]      p_aci_cmd_params_set_app_latency  Pointer to the set_application_latency command parameters in ::aci_cmd_params_dtm_cmd_t

  252.  *

  253.  *  @return         None

  254.  */

  255. void acil_encode_cmd_set_app_latency(uint8_t *buffer, aci_cmd_params_set_app_latency_t *p_aci_cmd_params_set_app_latency);

  256. 

  257. /** @brief Encode the ACI message for setup

  258.  *

  259.  *  @param[in,out]  buffer                          Pointer to ACI message buffer

  260.  *  @param[in]      p_cmd_params_set_run_behaviour  Pointer to the setup data in ::aci_cmd_params_setup_t

  261.  *  @param[in]      setup_data_size                 Size of setup message

  262.  *

  263.  *  @return         None

  264.  */

  265. void acil_encode_cmd_setup(uint8_t *buffer, aci_cmd_params_setup_t *p_aci_cmd_params_setup, uint8_t setup_data_size);

  266. 

  267. /** @brief Encode the ACI message for DTM command

  268.  *

  269.  *  @param[in,out]  buffer                          Pointer to ACI message buffer

  270.  *  @param[in]      p_cmd_params_set_run_behaviour  Pointer to the DTM command parameters in ::aci_cmd_params_dtm_cmd_t

  271.  *

  272.  *  @return         None

  273.  */

  274. void acil_encode_cmd_dtm_cmd(uint8_t *buffer, aci_cmd_params_dtm_cmd_t *p_aci_cmd_params_dtm_cmd);

  275. 

  276. /** @brief Encode the ACI message for Set Key Request command

  277.  *

  278.  *  @param[in,out]  buffer      Pointer to ACI message buffer

  279.  *

  280.  *  @return         None

  281.  */

  282. void acil_encode_cmd_set_key(uint8_t *buffer, aci_cmd_params_set_key_t *p_aci_cmd_params_set_key);

  283. 

  284. /** @brief Encode the ACI message for Bond Security Request command

  285.  *

  286.  *  @param[in,out]  buffer      Pointer to ACI message buffer

  287.  *

  288.  *  @return         None

  289.  */

  290. void acil_encode_cmd_bond_security_request(uint8_t *buffer);

  291. 

  292. /** @brief Encode the ACI message

  293.  *

  294.  *  @param[in,out]  buffer      Pointer to ACI message buffer

  295.  *  @param[in]      p_aci_cmd   Pointer to ACI command data in ::aci_cmd_t

  296.  *  @param[in]      bool       

  297.  *

  298.  *  @return         bool         true, if succesful, else returns false

  299.  */

  300. bool acil_encode_cmd(uint8_t *buffer, aci_cmd_t *p_aci_cmd);

  301. 

  302. /** @brief Encode the ACI message for Broadcast command

  303.  *

  304.  *  @param[in,out]  buffer      Pointer to ACI message buffer

  305.  *  @param[in]      p_aci_cmd   Pointer to ACI command data in ::aci_cmd_params_broadcast_t

  306.  *

  307.  *  @return         None

  308.  */

  309. void acil_encode_cmd_broadcast(uint8_t *buffer,  aci_cmd_params_broadcast_t * p_aci_cmd_params_broadcast);

  310. 

  311. /** @brief Encode the ACI message for Open Adv Pipes

  312.  *

  313.  *  @param[in,out]  buffer      Pointer to ACI message buffer

  314.  *  @param[in]      p_aci_cmd   Pointer to ACI command data in ::aci_cmd_params_open_adv_pipe_t

  315.  *

  316.  *  @return         None

  317.  */

  318. void acil_encode_cmd_open_adv_pipes(uint8_t *buffer, aci_cmd_params_open_adv_pipe_t * p_aci_cmd_params_set_adv_svc_data);

  319. 

  320. /** @brief Decode the ACI event command response

  321.  *

  322.  *  @param[in]      buffer_in  Pointer to message received

  323.  *  @param[in,out]  buffer     Pointer to the decoded message in ::aci_evt_params_cmd_rsp_t

  324.  *

  325.  *  @return         None

  326.  */

  327. void acil_decode_evt_command_response(uint8_t *buffer_in, aci_evt_params_cmd_rsp_t *p_evt_params_cmd_rsp);

  328. 

  329. /** @brief Decode the ACI event device started

  330.  *

  331.  *  @param[in]      buffer_in  Pointer to message received

  332.  *  @param[in,out]  p_aci_evt  Pointer to the decoded message in ::aci_evt_params_device_started_t

  333.  *

  334.  *  @return         None

  335.  */

  336. void acil_decode_evt_device_started(uint8_t *buffer_in, aci_evt_params_device_started_t *p_evt_params_device_started);

  337. 

  338. /** @brief Decode the ACI event pipe status

  339.  *

  340.  *  @param[in]      buffer_in  Pointer to message received

  341.  *  @param[in,out]  p_aci_evt_params_pipe_status  Pointer to the decoded message in ::aci_evt_params_pipe_status_t

  342.  *

  343.  *  @return         None

  344.  */

  345. void acil_decode_evt_pipe_status(uint8_t *buffer_in, aci_evt_params_pipe_status_t *p_aci_evt_params_pipe_status);

  346. 

  347. /** @brief Decode the ACI event for disconnected

  348.  *

  349.  *  @param[in]      buffer_in                      Pointer to message received

  350.  *  @param[in,out]  p_aci_evt_params_disconnected  Pointer to the decoded message in ::aci_evt_params_disconnected_t

  351.  *

  352.  *  @return         None

  353.  */

  354. void acil_decode_evt_disconnected(uint8_t *buffer_in, aci_evt_params_disconnected_t *p_aci_evt_params_disconnected);

  355. 

  356. /** @brief Decode the ACI event for bond status

  357.  *

  358.  *  @param[in]      buffer_in                     Pointer to message received

  359.  *  @param[in,out]  p_aci_evt_params_bond_status  Pointer to the decoded message in ::aci_evt_params_bond_status_t

  360.  *

  361.  *  @return         None

  362.  */

  363. void acil_decode_evt_bond_status(uint8_t *buffer_in, aci_evt_params_bond_status_t *p_aci_evt_params_bond_status);

  364. 

  365. /** @brief Decode the ACI event for data received

  366.  *

  367.  *  @param[in]      buffer_in                   Pointer to message received

  368.  *  @param[in,out]  p_evt_params_data_received  Pointer to the decoded message in ::aci_evt_params_data_received_t

  369.  *

  370.  *  @return         size                        Received data size

  371.  */

  372. uint8_t acil_decode_evt_data_received(uint8_t *buffer_in, aci_evt_params_data_received_t *p_evt_params_data_received);

  373. 

  374. /** @brief Decode the ACI event data acknowledgement

  375.  *

  376.  *  @param[in]      buffer_in               Pointer to message received

  377.  *  @param[in,out]  p_evt_params_data_ack   Pointer to the decoded message in ::aci_evt_params_data_ack_t

  378.  *

  379.  *  @return         None

  380.  */

  381. void acil_decode_evt_data_ack(uint8_t *buffer_in, aci_evt_params_data_ack_t *p_evt_params_data_ack);

  382. 

  383. /** @brief Decode the ACI event for hardware error

  384.  *

  385.  *  @param[in]      buffer_in                  Pointer to message received

  386.  *  @param[in,out]  p_aci_evt_params_hw_error  Pointer to the decoded message in ::aci_evt_params_hw_error_t

  387.  *

  388.  *  @return         size                     Size of debug information

  389.  */

  390. uint8_t acil_decode_evt_hw_error(uint8_t *buffer_in, aci_evt_params_hw_error_t *p_aci_evt_params_hw_error);

  391. 

  392. /** @brief Decode the ACI event data credit

  393.  *

  394.  *  @param[in]      buffer_in                 Pointer to message received

  395.  *  @param[in,out]  p_evt_params_data_credit  Pointer to the decoded message in ::aci_evt_params_data_credit_t

  396.  *

  397.  *  @return         None

  398.  */

  399. void acil_decode_evt_credit(uint8_t *buffer_in, aci_evt_params_data_credit_t *p_evt_params_data_credit);

  400. 

  401. /** @brief Decode the ACI event for connected

  402.  *

  403.  *  @param[in]      buffer_in                   Pointer to message received

  404.  *  @param[in,out]  p_aci_evt_params_connected  Pointer to the decoded message in ::aci_evt_params_connected_t

  405.  *

  406.  *  @return         None

  407.  */

  408. void acil_decode_evt_connected(uint8_t *buffer_in, aci_evt_params_connected_t *p_aci_evt_params_connected);

  409. 

  410. /** @brief Decode the ACI event for timing

  411.  *

  412.  *  @param[in]      buffer_in             Pointer to message received

  413.  *  @param[in,out]  p_evt_params_timing   Pointer to the decoded message in ::aci_evt_params_timing_t

  414.  *

  415.  *  @return         None

  416.  */

  417. void acil_decode_evt_timing(uint8_t *buffer_in, aci_evt_params_timing_t *p_evt_params_timing);

  418. 

  419. /** @brief Decode the ACI event for pipe error

  420.  *

  421.  *  @param[in]      buffer_in                 Pointer to message received

  422.  *  @param[in,out]  p_evt_params_pipe_error   Pointer to the decoded message in ::aci_evt_params_pipe_error_t

  423.  *

  424.  */

  425. void acil_decode_evt_pipe_error(uint8_t *buffer_in, aci_evt_params_pipe_error_t *p_evt_params_pipe_error);

  426. 

  427. /** @brief Decode the ACI event for key request

  428.  *

  429.  *  @param[in]      buffer_in               Pointer to message received

  430.  *  @param[in,out]  p_evt_params_key_type   Pointer to the decoded message in ::aci_evt_params_key_type_t

  431.  *

  432.  *  @return         None

  433.  */

  434. void acil_decode_evt_key_request(uint8_t *buffer_in, aci_evt_params_key_request_t *p_evt_params_key_request);

  435. 

  436. /** @brief Decode the ACI event for echo

  437.  *

  438.  *  @param[in]      buffer_in    Pointer to message received

  439.  *  @param[in,out]  buffer_out   Pointer to the echo message (max size of buffer ::ACI_ECHO_DATA_MAX_LEN)

  440.  *

  441.  *  @return         size         Received echo message size

  442.  */

  443. uint8_t acil_decode_evt_echo(uint8_t *buffer_in, aci_evt_params_echo_t *buffer_out);

  444. 

  445. /** @brief Decode the ACI event

  446.  *

  447.  *  @param[in]      buffer_in   Pointer to message received

  448.  *  @param[in,out]  p_aci_evt   Pointer to the decoded message in ::aci_evt_t

  449.  *

  450.  *  @return         bool         true, if succesful, else returns false

  451.  */

  452. bool acil_decode_evt(uint8_t *buffer_in, aci_evt_t *p_aci_evt);

  453. 

  454. /** @brief Decode the Display Key Event

  455.  *

  456.  *  @param[in]      buffer_in   Pointer to message received

  457.  *  @param[in,out]  p_aci_evt   Pointer to the decoded message in ::aci_evt_params_display_passkey_t

  458.  *

  459.  *  @return         None

  460.  */

  461. void acil_decode_evt_display_passkey(uint8_t *buffer_in, aci_evt_params_display_passkey_t *p_aci_evt_params_display_passkey);

  462. 

  463. #endif /* _acilib_IF_H_ */