xref: /btstack/src/classic/obex.h (revision 31ee742e25a72f0f805e0d638eeafd9bbf930814)
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 #ifndef __OBEX_H
39 
40 #define OBEX_OPCODE_CONNECT                0x80
41 #define OBEX_OPCODE_DISCONNECT             0x81
42 #define OBEX_OPCODE_PUT                    0x02
43 #define OBEX_OPCODE_CLOSE                  0x82
44 #define OBEX_OPCODE_GET                    0x03
45 #define OBEX_OPCODE_SETPATH                0x85
46 #define OBEX_OPCODE_SESSION                0x87
47 #define OBEX_OPCODE_ABORT                  0xFF
48 
49 #define OBEX_RESP_SUCCESS                  0xA0
50 #define OBEX_RESP_CONTINUE                 0x90
51 #define OBEX_RESP_CANCELED                 0xC1
52 #define OBEX_RESP_NOT_FOUND                0xC4
53 #define OBEX_RESP_REFUSED                  0xC6
54 
55 #define OBEX_HEADER_BODY                   0x48
56 #define OBEX_HEADER_END_OF_BODY            0x49
57 #define OBEX_HEADER_COUNT                  0xC0
58 #define OBEX_HEADER_NAME                   0x01
59 #define OBEX_HEADER_TYPE                   0x42
60 #define OBEX_HEADER_LENGTH                 0xC3
61 #define OBEX_HEADER_TIME_ISO_8601          0x44
62 #define OBEX_HEADER_TIME_4_BYTE            0xC4
63 #define OBEX_HEADER_DESCRIPTION            0x05
64 #define OBEX_HEADER_TARGET                 0x46
65 #define OBEX_HEADER_HTTP                   0x47
66 #define OBEX_HEADER_WHO                    0x4A
67 #define OBEX_HEADER_OBJECT_CLASS           0x4F
68 #define OBEX_HEADER_APPLICATION_PARAMETERS 0x4C
69 #define OBEX_HEADER_CONNECTION_ID          0xCb
70 
71 #define OBEX_OPCODE_FINAL_BIT_MASK         0x80
72 
73 #define OBEX_VERSION                       0x14
74 
75 #define OBEX_PACKET_HEADER_SIZE            3
76 #define OBEX_PACKET_OPCODE_OFFSET          0
77 #define OBEX_PACKET_LENGTH_OFFSET          1
78 #define OBEX_MAX_PACKETLEN_DEFAULT         0xffff
79 
80 #define OBEX_CONNECTION_ID_INVALID         0xFFFFFFFF
81 
82 /**
83  * PBAP
84  */
85 
86 // PBAP Application Parameters Tag IDs
87 
88 // Order - 0x01 - 1 byte: 0x00 = indexed 0x01 = alphanumeric 0x02 = phonetic
89 #define PBAP_APPLICATION_PARAMETER_ORDER 0x01
90 // SearchValue - 0x02 - variable - Text
91 #define PBAP_APPLICATION_PARAMETER_SEARCH_VALUE 0x02
92 // SearchProperty - 0x03 - 1 byte - 0x00= Name 0x01= Number 0x02= Sound
93 #define PBAP_APPLICATION_PARAMETER_SEARCH_PROPERTY 0x03
94 // MaxListCount - 0x04 - 2 bytes - 0x0000 to 0xFFFF
95 #define PBAP_APPLICATION_PARAMETER_MAX_LIST_COUNT 0x04
96 // ListStartOffset - 0x05 - 2 bytes - 0x0000 to 0xFFFF
97 #define PBAP_APPLICATION_PARAMETER_LIST_START_OFFSET 0x05
98 // PropertySelector - 0x06 - 8 bytes - 64 bits mask
99 #define PBAP_APPLICATION_PARAMETER_PROPERTY_SELECTOR 0x06
100 // Format - 0x07 - 1 byte - 0x00 = 2.1 0x01 = 3.0
101 #define PBAP_APPLICATION_PARAMETER_FORMAT 0x07
102 // PhonebookSize - 0x08 - 2 bytes - 0x0000 to 0xFFFF
103 #define PBAP_APPLICATION_PARAMETER_PHONEBOOK_SIZE 0x08
104 // NewMissedCalls - 0x09 - 1 byte - 0x00 to 0xFF
105 #define PBAP_APPLICATION_PARAMETER_NEW_MISSED_CALLS 0x09
106 // PrimaryVersionCounter - 0x0A - 16 bytes - 0 to (2128 – 1)
107 #define PBAP_APPLICATION_PARAMETER_PRIMARY_VERSION_COUNTER 0x0A
108 // SecondaryVersionCounter - 0x0B - 16 bytes - 0 to (2128 – 1)
109 #define PBAP_APPLICATION_PARAMETER_SECONDARY_VERSION_COUNTER 0x0B
110 // vCardSelector - 0x0C - 8 bytes - 64 bits mask
111 #define PBAP_APPLICATION_PARAMETER_VCARD_SELECTOR 0x0C
112 // DatabaseIdentifier - 0x0D - 16 bytes - 0 to (2128 – 1)
113 #define PBAP_APPLICATION_PARAMETER_DATABASE_IDENTIFIER 0x0D
114 // vCardSelectorOperator - 0x0E - 1 byte - 0x00 = OR 0x01 = AND
115 #define PBAP_APPLICATION_PARAMETER_VCARD_SELECTOR_OPERATOR 0x0E
116 // ResetNewMissedCalls -   0x0F -  1 byte
117 #define PBAP_APPLICATION_PARAMETER_RESET_NEW_MISSED_CALLS 0x0F
118 
119 #endif
120