xref: /btstack/src/classic/obex.h (revision ced70f9bfeafe291ec597a3a9cc862e39e0da3ce)
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 BLUEKITCHEN
24  * GMBH 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 #ifndef OBEX_H
39 #define OBEX_H
40 
41 // From IR OBEX V1.5 - some opcodes have high bit always set
42 #define OBEX_OPCODE_CONNECT                0x80
43 #define OBEX_OPCODE_DISCONNECT             0x81
44 #define OBEX_OPCODE_PUT                    0x02
45 #define OBEX_OPCODE_GET                    0x03
46 #define OBEX_OPCODE_SETPATH                0x85
47 #define OBEX_OPCODE_ACTION                 0x06
48 #define OBEX_OPCODE_SESSION                0x87
49 #define OBEX_OPCODE_ABORT                  0xFF
50 
51 #define OBEX_OPCODE_FINAL_BIT_MASK         0x80
52 
53 #define OBEX_RESP_CONTINUE                 0x90
54 #define OBEX_RESP_SUCCESS                  0xA0
55 #define OBEX_RESP_BAD_REQUEST              0xC0
56 #define OBEX_RESP_UNAUTHORIZED             0xC1
57 #define OBEX_RESP_FORBIDDEN                0xC3
58 #define OBEX_RESP_NOT_FOUND                0xC4
59 #define OBEX_RESP_NOT_ACCEPTABLE           0xC6
60 #define OBEX_RESP_UNSUPPORTED_MEDIA_TYPE   0xCF
61 #define OBEX_RESP_ENTITY_TOO_LARGE         0xCD
62 #define OBEX_RESP_NOT_IMPLEMENTED          0xD1
63 
64 #define OBEX_HEADER_NAME                           0x01
65 #define OBEX_HEADER_DESCRIPTION                    0x05
66 // user defined 0x30..0x3f: unicode string
67 #define OBEX_HEADER_IMG_HANDLE                     0x30
68 #define OBEX_HEADER_TYPE                           0x42
69 #define OBEX_HEADER_TIME_ISO_8601                  0x44
70 #define OBEX_HEADER_TARGET                         0x46
71 #define OBEX_HEADER_HTTP                           0x47
72 #define OBEX_HEADER_BODY                           0x48
73 #define OBEX_HEADER_END_OF_BODY                    0x49
74 #define OBEX_HEADER_WHO                            0x4A
75 #define OBEX_HEADER_APPLICATION_PARAMETERS         0x4C
76 #define OBEX_HEADER_AUTHENTICATION_CHALLENGE       0x4D
77 #define OBEX_HEADER_AUTHENTICATION_RESPONSE        0x4E
78 #define OBEX_HEADER_OBJECT_CLASS                   0x4F
79 // user defined 0x70..0x7f: byte sequence
80 #define OBEX_HEADER_IMG_DESCRIPTOR                 0x71
81 #define OBEX_HEADER_SINGLE_RESPONSE_MODE           0x97
82 #define OBEX_HEADER_SINGLE_RESPONSE_MODE_PARAMETER 0x98
83 // user defined 0xB0..0xBF: single byte
84 #define OBEX_HEADER_COUNT                          0xC0
85 #define OBEX_HEADER_LENGTH                         0xC3
86 #define OBEX_HEADER_TIME_4_BYTE                    0xC4
87 #define OBEX_HEADER_CONNECTION_ID                  0xCB
88 // user defined 0xF0..0xFF: 4 byte integer
89 
90 #define OBEX_VERSION                       0x14
91 
92 #define OBEX_PACKET_HEADER_SIZE            3
93 #define OBEX_PACKET_OPCODE_OFFSET          0
94 #define OBEX_PACKET_LENGTH_OFFSET          1
95 #define OBEX_MAX_PACKETLEN_DEFAULT         0xffff
96 
97 #define OBEX_CONNECTION_ID_INVALID         0xFFFFFFFF
98 
99 /* SRM header values */
100 #define OBEX_SRM_DISABLE                            0x00
101 #define OBEX_SRM_ENABLE                             0x01
102 #define OBEX_SRM_INDICATE                           0x02
103 
104 /* SRMP header values */
105 #define OBEX_SRMP_NEXT                              0x00
106 #define OBEX_SRMP_WAIT                              0x01
107 #define OBEX_SRMP_NEXT_WAIT                         0x02
108 
109 
110 /**
111  * PBAP
112  */
113 
114 // PBAP Application Parameters Tag IDs
115 
116 // Order - 0x01 - 1 byte: 0x00 = indexed 0x01 = alphanumeric 0x02 = phonetic
117 #define PBAP_APPLICATION_PARAMETER_ORDER 0x01
118 // SearchValue - 0x02 - variable - Text
119 #define PBAP_APPLICATION_PARAMETER_SEARCH_VALUE 0x02
120 // SearchProperty - 0x03 - 1 byte - 0x00= Name 0x01= Number 0x02= Sound
121 #define PBAP_APPLICATION_PARAMETER_SEARCH_PROPERTY 0x03
122 // MaxListCount - 0x04 - 2 bytes - 0x0000 to 0xFFFF
123 #define PBAP_APPLICATION_PARAMETER_MAX_LIST_COUNT 0x04
124 // ListStartOffset - 0x05 - 2 bytes - 0x0000 to 0xFFFF
125 #define PBAP_APPLICATION_PARAMETER_LIST_START_OFFSET 0x05
126 // PropertySelector - 0x06 - 8 bytes - 64 bits mask
127 #define PBAP_APPLICATION_PARAMETER_PROPERTY_SELECTOR 0x06
128 // Format - 0x07 - 1 byte - 0x00 = 2.1 0x01 = 3.0
129 #define PBAP_APPLICATION_PARAMETER_FORMAT 0x07
130 // PhonebookSize - 0x08 - 2 bytes - 0x0000 to 0xFFFF
131 #define PBAP_APPLICATION_PARAMETER_PHONEBOOK_SIZE 0x08
132 // NewMissedCalls - 0x09 - 1 byte - 0x00 to 0xFF
133 #define PBAP_APPLICATION_PARAMETER_NEW_MISSED_CALLS 0x09
134 // PrimaryVersionCounter - 0x0A - 16 bytes - 0 to (2128 – 1)
135 #define PBAP_APPLICATION_PARAMETER_PRIMARY_VERSION_COUNTER 0x0A
136 // SecondaryVersionCounter - 0x0B - 16 bytes - 0 to (2128 – 1)
137 #define PBAP_APPLICATION_PARAMETER_SECONDARY_VERSION_COUNTER 0x0B
138 // vCardSelector - 0x0C - 8 bytes - 64 bits mask
139 #define PBAP_APPLICATION_PARAMETER_VCARD_SELECTOR 0x0C
140 // DatabaseIdentifier - 0x0D - 16 bytes - 0 to (2128 – 1)
141 #define PBAP_APPLICATION_PARAMETER_DATABASE_IDENTIFIER 0x0D
142 // vCardSelectorOperator - 0x0E - 1 byte - 0x00 = OR 0x01 = AND
143 #define PBAP_APPLICATION_PARAMETER_VCARD_SELECTOR_OPERATOR 0x0E
144 // ResetNewMissedCalls -   0x0F -  1 byte
145 #define PBAP_APPLICATION_PARAMETER_RESET_NEW_MISSED_CALLS 0x0F
146 // PbapSupportedFeatures - 0x10 - 4 bytes
147 #define PBAP_APPLICATION_PARAMETER_PBAP_SUPPORTED_FEATURES 0x10
148 
149 #endif
150