1 /* 2 * Copyright (C) 2014 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 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 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS 24 * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 // ***************************************************************************** 39 // 40 // Minimal setup for HFP Audio Gateway (AG) unit (!! UNDER DEVELOPMENT !!) 41 // 42 // ***************************************************************************** 43 44 45 #ifndef btstack_hfp_ag_h 46 #define btstack_hfp_ag_h 47 48 #include "hci.h" 49 #include "classic/sdp_query_rfcomm.h" 50 #include "classic/hfp.h" 51 52 #if defined __cplusplus 53 extern "C" { 54 #endif 55 56 /* API_START */ 57 58 /** 59 * @brief Create HFP Audio Gateway (AG) SDP service record. 60 */ 61 void hfp_ag_create_sdp_record(uint8_t * service, int rfcomm_channel_nr, const char * name, uint8_t ability_to_reject_call, uint16_t supported_features);; 62 63 /** 64 * @brief Intialize HFP Audio Gateway (AG) device. 65 * TODO: move optional params into setters 66 */ 67 void hfp_ag_init(uint16_t rfcomm_channel_nr, uint32_t supported_features, 68 uint8_t * codecs, int codecs_nr, 69 hfp_ag_indicator_t * ag_indicators, int ag_indicators_nr, 70 hfp_generic_status_indicator_t * hf_indicators, int hf_indicators_nr, 71 const char *call_hold_services[], int call_hold_services_nr); 72 73 /** 74 * @brief Register callback for the HFP Audio Gateway (AG) client. 75 */ 76 void hfp_ag_register_packet_handler(hfp_callback_t callback); 77 78 /** 79 * @brief Establish RFCOMM connection, and perform service level connection agreement: 80 * - exchange of supported features 81 * - report Audio Gateway (AG) indicators and their status 82 * - enable indicator status update in the AG 83 * - accept the information about available codecs in the Hands-Free (HF), if sent 84 * - report own information describing the call hold and multiparty services, if possible 85 * - report which HF indicators are enabled on the AG, if possible 86 */ 87 void hfp_ag_establish_service_level_connection(bd_addr_t bd_addr); 88 89 /** 90 * @brief Release the RFCOMM channel and the audio connection between the HF and the AG. 91 * TODO: trigger release of the audio connection 92 */ 93 void hfp_ag_release_service_level_connection(bd_addr_t bd_addr); 94 95 /** 96 * @brief Report Extended Audio Gateway Error result codes in the AG. 97 * Whenever there is an error relating to the functionality of the AG as a 98 * result of AT command, the AG shall send +CME ERROR: 99 * - +CME ERROR: 0 - AG failure 100 * - +CME ERROR: 1 - no connection to phone 101 * - +CME ERROR: 3 - operation not allowed 102 * - +CME ERROR: 4 - operation not supported 103 * - +CME ERROR: 5 - PH-SIM PIN required 104 * - +CME ERROR: 10 - SIM not inserted 105 * - +CME ERROR: 11 - SIM PIN required 106 * - +CME ERROR: 12 - SIM PUK required 107 * - +CME ERROR: 13 - SIM failure 108 * - +CME ERROR: 14 - SIM busy 109 * - +CME ERROR: 16 - incorrect password 110 * - +CME ERROR: 17 - SIM PIN2 required 111 * - +CME ERROR: 18 - SIM PUK2 required 112 * - +CME ERROR: 20 - memory full 113 * - +CME ERROR: 21 - invalid index 114 * - +CME ERROR: 23 - memory failure 115 * - +CME ERROR: 24 - text string too long 116 * - +CME ERROR: 25 - invalid characters in text string 117 * - +CME ERROR: 26 - dial string too long 118 * - +CME ERROR: 27 - invalid characters in dial string 119 * - +CME ERROR: 30 - no network service 120 * - +CME ERROR: 31 - network Timeout. 121 * - +CME ERROR: 32 - network not allowed – Emergency calls only 122 */ 123 void hfp_ag_report_extended_audio_gateway_error_result_code(bd_addr_t bd_addr, hfp_cme_error_t error); 124 125 /** 126 * @brief Report the change in AG's call status. 127 * Call status: 128 * - 0 = No calls (held or active) 129 * - 1 = Call is present (active or held) 130 */ 131 void hfp_ag_transfer_call_status(bd_addr_t bd_addr, hfp_call_status_t status); 132 133 /** 134 * @brief Report the change in AG's call setup status. 135 * Call setup status: 136 * - 0 = No call setup in progress 137 * - 1 = Incoming call setup in progress 138 * - 2 = Outgoing call setup in dialing state 139 * - 3 = Outgoing call setup in alerting state 140 */ 141 void hfp_ag_transfer_callsetup_status(bd_addr_t bd_addr, hfp_callsetup_status_t status); 142 143 /** 144 * @brief Report the change in AG's held call status. 145 * Held call status: 146 * - 0 = No calls held 147 * - 1 = Call is placed on hold or active/held calls are swapped 148 * - 2 = Call on hold, no active calls 149 */ 150 void hfp_ag_transfer_callheld_status(bd_addr_t bd_addr, hfp_callheld_status_t status); 151 152 /** 153 * @brief 154 */ 155 void hfp_ag_negotiate_codecs(bd_addr_t bd_addr); 156 157 void hfp_ag_establish_audio_connection(bd_addr_t bd_addr); 158 159 /** 160 * @brief 161 */ 162 void hfp_ag_release_audio_connection(bd_addr_t bd_addr); 163 164 165 /* API_END */ 166 167 #if defined __cplusplus 168 } 169 #endif 170 171 #endif