1 /****************************************************************************** 2 * 3 * Copyright 2003-2016 Broadcom Corporation 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); 6 * you may not use this file except in compliance with the License. 7 * You may obtain a copy of the License at: 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 * 17 ******************************************************************************/ 18 19 /****************************************************************************** 20 * 21 * VRCP internal header file. 22 * 23 ******************************************************************************/ 24 25 #ifndef AVRC_INT_H 26 #define AVRC_INT_H 27 28 #include "internal_include/bt_target.h" 29 #include "osi/include/alarm.h" 30 #include "osi/include/fixed_queue.h" 31 #include "stack/include/avrc_api.h" 32 #include "stack/include/bt_hdr.h" 33 34 /* DEBUG FLAGS 35 * 36 * #define META_DEBUG_ENABLED 37 */ 38 /***************************************************************************** 39 * Constants 40 ****************************************************************************/ 41 42 /* Number of attributes in AVRC SDP record. */ 43 #define AVRC_NUM_ATTR 6 44 45 /* Number of protocol elements in protocol element list. */ 46 #define AVRC_NUM_PROTO_ELEMS 2 47 48 #ifndef AVRC_MIN_CMD_LEN 49 #define AVRC_MIN_CMD_LEN 20 50 #endif 51 52 #define AVRC_UNIT_OPRND_BYTES 5 53 #define AVRC_SUB_OPRND_BYTES 4 54 #define AVRC_SUBRSP_OPRND_BYTES 3 55 #define AVRC_SUB_PAGE_MASK 7 56 #define AVRC_SUB_PAGE_SHIFT 4 57 #define AVRC_SUB_EXT_CODE 7 58 #define AVRC_PASS_OP_ID_MASK 0x7F 59 #define AVRC_PASS_STATE_MASK 0x80 60 #define AVRC_CMD_OPRND_PAD 0xFF 61 62 #define AVRC_CTYPE_MASK 0x0F 63 #define AVRC_SUBTYPE_MASK 0xF8 64 #define AVRC_SUBTYPE_SHIFT 3 65 #define AVRC_SUBID_MASK 0x07 66 #define AVRC_SUBID_IGNORE 0x07 67 68 #define AVRC_SINGLE_PARAM_SIZE 1 69 #define AVRC_METADATA_PKT_TYPE_MASK 0x03 70 #define AVRC_PASS_THOUGH_MSG_MASK \ 71 0x80 /* MSB of msg_type indicates the PAS THROUGH msg */ 72 #define AVRC_VENDOR_UNIQUE_MASK 0x70 /* vendor unique id */ 73 74 /* Company ID is 24-bit integer We can not use the macros in bt_types.h */ 75 #define AVRC_CO_ID_TO_BE_STREAM(p, u32) \ 76 { \ 77 *(p)++ = (uint8_t)((u32) >> 16); \ 78 *(p)++ = (uint8_t)((u32) >> 8); \ 79 *(p)++ = (uint8_t)(u32); \ 80 } 81 #define AVRC_BE_STREAM_TO_CO_ID(u32, p) \ 82 { \ 83 (u32) = (((uint32_t)(*((p) + 2))) + (((uint32_t)(*((p) + 1))) << 8) + \ 84 (((uint32_t)(*(p))) << 16)); \ 85 (p) += 3; \ 86 } 87 88 #define AVRC_AVC_HDR_SIZE 3 /* ctype, subunit*, opcode */ 89 90 #define AVRC_MIN_META_HDR_SIZE 4 /* pdu id(1), packet type(1), param len(2) */ 91 #define AVRC_MIN_BROWSE_HDR_SIZE 3 /* pdu id(1), param len(2) */ 92 93 #define AVRC_VENDOR_HDR_SIZE 6 /* ctype, subunit*, opcode, CO_ID */ 94 #define AVRC_MSG_VENDOR_OFFSET 23 95 #define AVRC_MIN_VENDOR_SIZE \ 96 (AVRC_MSG_VENDOR_OFFSET + BT_HDR_SIZE + AVRC_MIN_META_HDR_SIZE) 97 98 #define AVRC_PASS_THRU_SIZE 8 99 #define AVRC_MSG_PASS_THRU_OFFSET 25 100 #define AVRC_MIN_PASS_THRU_SIZE (AVRC_MSG_PASS_THRU_OFFSET + BT_HDR_SIZE + 4) 101 102 #define AVRC_MIN_BROWSE_SIZE \ 103 (AVCT_BROWSE_OFFSET + BT_HDR_SIZE + AVRC_MIN_BROWSE_HDR_SIZE) 104 105 #define AVRC_CTRL_PKT_LEN(pf, pk) \ 106 { (pf) = (uint8_t*)((pk) + 1) + (pk)->offset + 2; } 107 108 #define AVRC_MAX_CTRL_DATA_LEN (AVRC_PACKET_LEN) 109 110 /* Timeout for waiting for avrc command responses (in milliseconds) */ 111 #ifndef AVRC_CMD_TOUT_MS 112 #define AVRC_CMD_TOUT_MS (2 * 1000) 113 #endif 114 115 /* Flags for avrc_cb.ccb_int[].flags */ 116 #define AVRC_CB_FLAGS_RSP_PENDING 0x01 /* Waiting for AVRC response */ 117 118 /***************************************************************************** 119 * Type definitions 120 ****************************************************************************/ 121 122 /* type for Metadata fragmentation control block */ 123 typedef struct { 124 BT_HDR* p_fmsg; /* the fragmented message */ 125 uint8_t frag_pdu; /* the PDU ID for fragmentation */ 126 bool frag_enabled; /* fragmentation flag */ 127 } tAVRC_FRAG_CB; 128 129 /* type for Metadata re-assembly control block */ 130 typedef struct { 131 BT_HDR* p_rmsg; /* the received message */ 132 uint16_t rasm_offset; /* re-assembly flag, the offset of the start fragment */ 133 uint8_t rasm_pdu; /* the PDU ID for re-assembly */ 134 } tAVRC_RASM_CB; 135 136 /* AVRC internal connection control block */ 137 typedef struct { 138 fixed_queue_t* 139 cmd_q; /* Command queue for serializing vendor specific commands */ 140 uint8_t flags; /* See AVRC_CB_FLAGS_* definitions */ 141 alarm_t* tle; /* Command timeout timer */ 142 } tAVRC_CONN_INT_CB; 143 144 typedef struct { 145 tAVRC_CONN_CB 146 ccb[AVCT_NUM_CONN]; /* Connection control block from AVRC_Open API */ 147 tAVRC_CONN_INT_CB 148 ccb_int[AVCT_NUM_CONN]; /* Internal connection control block */ 149 tAVRC_FRAG_CB fcb[AVCT_NUM_CONN]; 150 tAVRC_RASM_CB rcb[AVCT_NUM_CONN]; 151 tAVRC_FIND_CBACK find_cback; /* sdp discovery callback */ 152 tSDP_DISCOVERY_DB* p_db; /* pointer to discovery database */ 153 uint16_t service_uuid; /* service UUID to search */ 154 } tAVRC_CB; 155 156 /****************************************************************************** 157 * Main Control Block 158 ******************************************************************************/ 159 extern tAVRC_CB avrc_cb; 160 161 bool avrc_is_valid_pdu_id(uint8_t pdu_id); 162 bool avrc_is_valid_player_attrib_value(uint8_t attrib, uint8_t value); 163 BT_HDR* avrc_alloc_ctrl_pkt(uint8_t pdu); 164 tAVRC_STS avrc_pars_pass_thru(tAVRC_MSG_PASS* p_msg, 165 uint16_t* p_vendor_unique_id); 166 uint8_t avrc_opcode_from_pdu(uint8_t pdu); 167 bool avrc_is_valid_opcode(uint8_t opcode); 168 void avrc_flush_cmd_q(uint8_t handle); 169 void avrc_start_cmd_timer(uint8_t handle, uint8_t label, uint8_t msg_mask); 170 void avrc_send_next_vendor_cmd(uint8_t handle); 171 172 #endif /* AVRC_INT_H */ 173