?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Tarball tree for barry-0.15.tar.bz2
[barry.git] / doc / www / doxygen / html / protostructs_8h-source.html
blobce0021b0bbe0687cbeaa1a6fd816dcb465891c22
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>Barry: protostructs.h Source File</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
6 </head><body>
7 <!-- Generated by Doxygen 1.5.6 -->
8 <div class="navigation" id="top">
9 <div class="tabs">
10 <ul>
11 <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12 <li><a href="modules.html"><span>Modules</span></a></li>
13 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
14 <li><a href="classes.html"><span>Classes</span></a></li>
15 <li class="current"><a href="files.html"><span>Files</span></a></li>
16 <li><a href="dirs.html"><span>Directories</span></a></li>
17 </ul>
18 </div>
19 <div class="navpath"><a class="el" href="dir_edc0f428e3eefcfdce9c25befd901c57.html">src</a>
20 </div>
21 </div>
22 <div class="contents">
23 <h1>protostructs.h</h1><a href="protostructs_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
24 <a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file protostructs.h</span>
25 <a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// USB Blackberry bulk protocol API. This is split out from</span>
26 <a name="l00004"></a>00004 <span class="comment"></span><span class="comment">/// protocol.h so that low level, packed structs can be</span>
27 <a name="l00005"></a>00005 <span class="comment"></span><span class="comment">/// compiled separately from the application. This prevents</span>
28 <a name="l00006"></a>00006 <span class="comment"></span><span class="comment">/// aliasing problems in the application, or using</span>
29 <a name="l00007"></a>00007 <span class="comment"></span><span class="comment">/// -fno-strict-aliasing, which the library only needs.</span>
30 <a name="l00008"></a>00008 <span class="comment"></span><span class="comment">///</span>
31 <a name="l00009"></a>00009 <span class="comment"></span><span class="comment">/// Do not include this in any Barry library header.</span>
32 <a name="l00010"></a>00010 <span class="comment"></span><span class="comment">/// This may only be included from .cc files, in order</span>
33 <a name="l00011"></a>00011 <span class="comment"></span><span class="comment">/// to hide aliasing concernes from the application.</span>
34 <a name="l00012"></a>00012 <span class="comment"></span><span class="comment">///</span>
35 <a name="l00013"></a>00013 <span class="comment"></span>
36 <a name="l00014"></a>00014 <span class="comment">/*</span>
37 <a name="l00015"></a>00015 <span class="comment"> Copyright (C) 2005-2009, Net Direct Inc. (http://www.netdirect.ca/)</span>
38 <a name="l00016"></a>00016 <span class="comment"></span>
39 <a name="l00017"></a>00017 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
40 <a name="l00018"></a>00018 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
41 <a name="l00019"></a>00019 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
42 <a name="l00020"></a>00020 <span class="comment"> (at your option) any later version.</span>
43 <a name="l00021"></a>00021 <span class="comment"></span>
44 <a name="l00022"></a>00022 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
45 <a name="l00023"></a>00023 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
46 <a name="l00024"></a>00024 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
47 <a name="l00025"></a>00025 <span class="comment"></span>
48 <a name="l00026"></a>00026 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
49 <a name="l00027"></a>00027 <span class="comment"> root directory of this project for more details.</span>
50 <a name="l00028"></a>00028 <span class="comment">*/</span>
51 <a name="l00029"></a>00029
52 <a name="l00030"></a>00030 <span class="preprocessor">#ifndef __BARRY_PROTOSTRUCTS_H__</span>
53 <a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_PROTOSTRUCTS_H__</span>
54 <a name="l00032"></a>00032 <span class="preprocessor"></span>
55 <a name="l00033"></a>00033 <span class="preprocessor">#include &lt;stdint.h&gt;</span>
56 <a name="l00034"></a>00034 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
57 <a name="l00035"></a>00035
58 <a name="l00036"></a>00036 <span class="comment">// forward declarations</span>
59 <a name="l00037"></a>00037 <span class="keyword">namespace </span>Barry { <span class="keyword">class </span>Data; }
60 <a name="l00038"></a>00038
61 <a name="l00039"></a>00039 <span class="keyword">namespace </span>Barry { <span class="keyword">namespace </span>Protocol {
62 <a name="l00040"></a>00040 <span class="comment"></span>
63 <a name="l00041"></a>00041 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
64 <a name="l00042"></a>00042 <span class="comment"></span><span class="keyword">union </span>SizePacket
65 <a name="l00043"></a>00043 {
66 <a name="l00044"></a>00044 uint16_t size;
67 <a name="l00045"></a>00045 <span class="keywordtype">char</span> buffer[4];
68 <a name="l00046"></a>00046 } __attribute__ ((packed));
69 <a name="l00047"></a>00047
70 <a name="l00048"></a>00048 <span class="comment"></span>
71 <a name="l00049"></a>00049 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
72 <a name="l00050"></a>00050 <span class="comment"></span><span class="comment">// Record sub-field structs</span>
73 <a name="l00051"></a>00051
74 <a name="l00052"></a>00052 <span class="keyword">struct </span>GroupLink <span class="comment">// used for Contacts records</span>
75 <a name="l00053"></a>00053 {
76 <a name="l00054"></a>00054 uint32_t uniqueId;
77 <a name="l00055"></a>00055 uint16_t unknown;
78 <a name="l00056"></a>00056 } __attribute__ ((packed));
79 <a name="l00057"></a>00057
80 <a name="l00058"></a>00058 <span class="keyword">struct </span>MessageAddress <span class="comment">// used for Message records</span>
81 <a name="l00059"></a>00059 {
82 <a name="l00060"></a>00060 uint8_t unknown[8];
83 <a name="l00061"></a>00061 uint8_t addr[1]; <span class="comment">// 2 null terminated strings: first</span>
84 <a name="l00062"></a>00062 <span class="comment">// contains full name, second contains</span>
85 <a name="l00063"></a>00063 <span class="comment">// the email address</span>
86 <a name="l00064"></a>00064 } __attribute__ ((packed));
87 <a name="l00065"></a>00065
88 <a name="l00066"></a>00066 <span class="comment"></span>
89 <a name="l00067"></a>00067 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
90 <a name="l00068"></a>00068 <span class="comment"></span><span class="comment">// SMS Message field and record structures</span>
91 <a name="l00069"></a>00069
92 <a name="l00070"></a>00070 <span class="keyword">struct </span>SMSMetaData
93 <a name="l00071"></a>00071 {
94 <a name="l00072"></a>00072 uint8_t recv; <span class="comment">// if received, this is set to 1; otherwise 0</span>
95 <a name="l00073"></a>00073 uint8_t flags;
96 <a name="l00074"></a>00074 <span class="preprocessor">#define SMS_FLG_NEW_CONVERSATION 0x20</span>
97 <a name="l00075"></a>00075 <span class="preprocessor"></span><span class="preprocessor">#define SMS_FLG_SAVED 0x10</span>
98 <a name="l00076"></a>00076 <span class="preprocessor"></span><span class="preprocessor">#define SMS_FLG_DELETED 0x08</span>
99 <a name="l00077"></a>00077 <span class="preprocessor"></span><span class="preprocessor">#define SMS_FLG_OPENED 0x01</span>
100 <a name="l00078"></a>00078 <span class="preprocessor"></span>
101 <a name="l00079"></a>00079 uint8_t new_flag;
102 <a name="l00080"></a>00080 uint16_t zero; <span class="comment">// constantly 0</span>
103 <a name="l00081"></a>00081 uint32_t status;
104 <a name="l00082"></a>00082 <span class="preprocessor">#define SMS_STA_RECEIVED 0x000007ff</span>
105 <a name="l00083"></a>00083 <span class="preprocessor"></span><span class="preprocessor">#define SMS_STA_DRAFT 0x7fffffff</span>
106 <a name="l00084"></a>00084 <span class="preprocessor"></span>
107 <a name="l00085"></a>00085 uint32_t error_id;
108 <a name="l00086"></a>00086 uint64_t timestamp;
109 <a name="l00087"></a>00087 uint64_t service_center_timestamp;
110 <a name="l00088"></a>00088 uint8_t dcs;
111 <a name="l00089"></a>00089 <span class="preprocessor">#define SMS_DCS_7BIT 0x00</span>
112 <a name="l00090"></a>00090 <span class="preprocessor"></span><span class="preprocessor">#define SMS_DCS_8BIT 0x01</span>
113 <a name="l00091"></a>00091 <span class="preprocessor"></span><span class="preprocessor">#define SMS_DCS_UCS2 0x02</span>
114 <a name="l00092"></a>00092 <span class="preprocessor"></span>
115 <a name="l00093"></a>00093 } __attribute__ ((packed));
116 <a name="l00094"></a>00094 <span class="preprocessor">#define SMS_METADATA_SIZE (sizeof(Barry::Protocol::SMSMetaData))</span>
117 <a name="l00095"></a>00095 <span class="preprocessor"></span>
118 <a name="l00096"></a>00096
119 <a name="l00097"></a>00097 <span class="comment"></span>
120 <a name="l00098"></a>00098 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
121 <a name="l00099"></a>00099 <span class="comment"></span><span class="comment">// Record Field Formats</span>
122 <a name="l00100"></a>00100
123 <a name="l00101"></a>00101 <span class="keyword">struct </span>CommonField
124 <a name="l00102"></a>00102 {
125 <a name="l00103"></a>00103 uint16_t size; <span class="comment">// including null terminator</span>
126 <a name="l00104"></a>00104 uint8_t type;
127 <a name="l00105"></a>00105
128 <a name="l00106"></a>00106 <span class="keyword">union </span>CommonFieldData
129 <a name="l00107"></a>00107 {
130 <a name="l00108"></a>00108
131 <a name="l00109"></a>00109 GroupLink link;
132 <a name="l00110"></a>00110 MessageAddress addr;
133 <a name="l00111"></a>00111 SMSMetaData sms_metadata;
134 <a name="l00112"></a>00112 uint64_t timestamp;
135 <a name="l00113"></a>00113 uint32_t uint32;
136 <a name="l00114"></a>00114 int32_t min1900;
137 <a name="l00115"></a>00115 uint16_t code;
138 <a name="l00116"></a>00116 uint8_t raw[1];
139 <a name="l00117"></a>00117 int16_t int16;
140 <a name="l00118"></a>00118
141 <a name="l00119"></a>00119 } __attribute__ ((packed)) u;
142 <a name="l00120"></a>00120
143 <a name="l00121"></a>00121 } __attribute__ ((packed));
144 <a name="l00122"></a>00122 <span class="preprocessor">#define COMMON_FIELD_HEADER_SIZE (sizeof(Barry::Protocol::CommonField) - sizeof(Barry::Protocol::CommonField::CommonFieldData))</span>
145 <a name="l00123"></a>00123 <span class="preprocessor"></span><span class="preprocessor">#define COMMON_FIELD_MIN1900_SIZE (sizeof(int32_t))</span>
146 <a name="l00124"></a>00124 <span class="preprocessor"></span>
147 <a name="l00125"></a>00125 <span class="keyword">struct </span>CommandTableField
148 <a name="l00126"></a>00126 {
149 <a name="l00127"></a>00127 uint8_t size; <span class="comment">// no null terminator</span>
150 <a name="l00128"></a>00128 uint8_t code;
151 <a name="l00129"></a>00129 uint8_t name[1];
152 <a name="l00130"></a>00130 } __attribute__ ((packed));
153 <a name="l00131"></a>00131 <span class="preprocessor">#define COMMAND_FIELD_HEADER_SIZE (sizeof(Barry::Protocol::CommandTableField) - 1)</span>
154 <a name="l00132"></a>00132 <span class="preprocessor"></span>
155 <a name="l00133"></a>00133 <span class="keyword">struct </span>OldDBDBField
156 <a name="l00134"></a>00134 {
157 <a name="l00135"></a>00135 uint16_t dbNumber;
158 <a name="l00136"></a>00136 uint8_t unknown1;
159 <a name="l00137"></a>00137 uint32_t dbSize; <span class="comment">// assumed from Cassis docs...</span>
160 <a name="l00138"></a>00138 <span class="comment">// always 0 in USB</span>
161 <a name="l00139"></a>00139 uint16_t dbRecordCount;
162 <a name="l00140"></a>00140 uint16_t unknown2;
163 <a name="l00141"></a>00141 uint16_t nameSize; <span class="comment">// includes null terminator</span>
164 <a name="l00142"></a>00142 uint8_t name[1];
165 <a name="l00143"></a>00143 } __attribute__ ((packed));
166 <a name="l00144"></a>00144 <span class="preprocessor">#define OLD_DBDB_FIELD_HEADER_SIZE (sizeof(Barry::Protocol::OldDBDBField) - 1)</span>
167 <a name="l00145"></a>00145 <span class="preprocessor"></span>
168 <a name="l00146"></a>00146 <span class="keyword">struct </span>DBDBField
169 <a name="l00147"></a>00147 {
170 <a name="l00148"></a>00148 uint16_t dbNumber;
171 <a name="l00149"></a>00149 uint8_t unknown1;
172 <a name="l00150"></a>00150 uint32_t dbSize; <span class="comment">// assumed from Cassis docs...</span>
173 <a name="l00151"></a>00151 <span class="comment">// always 0 in USB</span>
174 <a name="l00152"></a>00152 uint32_t dbRecordCount;
175 <a name="l00153"></a>00153 uint16_t unknown2;
176 <a name="l00154"></a>00154 uint16_t nameSize; <span class="comment">// includes null terminator</span>
177 <a name="l00155"></a>00155 uint8_t unknown3;
178 <a name="l00156"></a>00156 uint8_t name[1]; <span class="comment">// followed by 2 zeros!</span>
179 <a name="l00157"></a>00157 uint16_t unknown; <span class="comment">// this comes after the</span>
180 <a name="l00158"></a>00158 <span class="comment">// null terminated name, but</span>
181 <a name="l00159"></a>00159 <span class="comment">// is here for size calcs</span>
182 <a name="l00160"></a>00160 } __attribute__ ((packed));
183 <a name="l00161"></a>00161 <span class="preprocessor">#define DBDB_FIELD_HEADER_SIZE (sizeof(Barry::Protocol::DBDBField) - 1)</span>
184 <a name="l00162"></a>00162 <span class="preprocessor"></span>
185 <a name="l00163"></a>00163 <span class="keyword">struct </span>RecordStateTableField
186 <a name="l00164"></a>00164 {
187 <a name="l00165"></a>00165 uint8_t rectype; <span class="comment">// it is unknown exactly what</span>
188 <a name="l00166"></a>00166 <span class="comment">// this field does, but it</span>
189 <a name="l00167"></a>00167 <span class="comment">// shows up here and in the</span>
190 <a name="l00168"></a>00168 <span class="comment">// tagged record header, and</span>
191 <a name="l00169"></a>00169 <span class="comment">// for some of the records</span>
192 <a name="l00170"></a>00170 <span class="comment">// they must match when writing</span>
193 <a name="l00171"></a>00171 uint16_t index;
194 <a name="l00172"></a>00172 uint32_t uniqueId; <span class="comment">// matches the uniqueId of say,</span>
195 <a name="l00173"></a>00173 <span class="comment">// address book records</span>
196 <a name="l00174"></a>00174 uint8_t flags; <span class="comment">// bit 0x01 is the dirty flag</span>
197 <a name="l00175"></a>00175 <span class="comment">// don't know if any other bits</span>
198 <a name="l00176"></a>00176 <span class="comment">// are used</span>
199 <a name="l00177"></a>00177 <span class="preprocessor">#define BARRY_RSTF_DIRTY 0x01</span>
200 <a name="l00178"></a>00178 <span class="preprocessor"></span> uint8_t unknown2[4];
201 <a name="l00179"></a>00179 } __attribute__ ((packed));
202 <a name="l00180"></a>00180
203 <a name="l00181"></a>00181 <span class="keyword">struct </span>CalendarRecurrenceDataField <span class="comment">// as documented in the Cassis project spec</span>
204 <a name="l00182"></a>00182 {
205 <a name="l00183"></a>00183 uint8_t type;
206 <a name="l00184"></a>00184 <span class="preprocessor">#define CRDF_TYPE_DAY 0x01</span>
207 <a name="l00185"></a>00185 <span class="preprocessor"></span><span class="preprocessor">#define CRDF_TYPE_MONTH_BY_DATE 0x03</span>
208 <a name="l00186"></a>00186 <span class="preprocessor"></span><span class="preprocessor">#define CRDF_TYPE_MONTH_BY_DAY 0x04</span>
209 <a name="l00187"></a>00187 <span class="preprocessor"></span><span class="preprocessor">#define CRDF_TYPE_YEAR_BY_DATE 0x05</span>
210 <a name="l00188"></a>00188 <span class="preprocessor"></span><span class="preprocessor">#define CRDF_TYPE_YEAR_BY_DAY 0x06</span>
211 <a name="l00189"></a>00189 <span class="preprocessor"></span><span class="preprocessor">#define CRDF_TYPE_WEEK 0x0c</span>
212 <a name="l00190"></a>00190 <span class="preprocessor"></span>
213 <a name="l00191"></a>00191 uint8_t unknown; <span class="comment">// always 0x01</span>
214 <a name="l00192"></a>00192 uint16_t interval;
215 <a name="l00193"></a>00193 uint32_t startTime;
216 <a name="l00194"></a>00194 uint32_t endTime; <span class="comment">// 0xFFFFFFFF for never</span>
217 <a name="l00195"></a>00195
218 <a name="l00196"></a>00196 <span class="keyword">union </span>Additional
219 <a name="l00197"></a>00197 {
220 <a name="l00198"></a>00198 <span class="comment">// Note: blank fields should be set to 0</span>
221 <a name="l00199"></a>00199
222 <a name="l00200"></a>00200 <span class="keyword">struct </span>Day
223 <a name="l00201"></a>00201 {
224 <a name="l00202"></a>00202 uint8_t day[6]; <span class="comment">// always zeros!</span>
225 <a name="l00203"></a>00203 } __attribute__ ((packed)) day;
226 <a name="l00204"></a>00204
227 <a name="l00205"></a>00205 struct MonthByDate
228 <a name="l00206"></a>00206 {
229 <a name="l00207"></a>00207 uint8_t monthDay; <span class="comment">// day of month to recur on</span>
230 <a name="l00208"></a>00208 <span class="comment">// (1-31)</span>
231 <a name="l00209"></a>00209 uint8_t blank[5];
232 <a name="l00210"></a>00210 } __attribute__ ((packed)) month_by_date;
233 <a name="l00211"></a>00211
234 <a name="l00212"></a>00212 struct MonthByDay
235 <a name="l00213"></a>00213 {
236 <a name="l00214"></a>00214 uint8_t weekDay; <span class="comment">// day of week to recur on (0-6)</span>
237 <a name="l00215"></a>00215 uint8_t week; <span class="comment">// week of month to recur on</span>
238 <a name="l00216"></a>00216 <span class="comment">// (1 to 5, first week, second</span>
239 <a name="l00217"></a>00217 <span class="comment">// week, etc)</span>
240 <a name="l00218"></a>00218 uint8_t blank[4];
241 <a name="l00219"></a>00219 } __attribute__ ((packed)) month_by_day;
242 <a name="l00220"></a>00220
243 <a name="l00221"></a>00221 struct YearByDate
244 <a name="l00222"></a>00222 {
245 <a name="l00223"></a>00223 uint8_t monthDay; <span class="comment">// day of month to recur on</span>
246 <a name="l00224"></a>00224 <span class="comment">// (1-31)</span>
247 <a name="l00225"></a>00225 uint8_t blank;
248 <a name="l00226"></a>00226 uint8_t month; <span class="comment">// month to recur on (1-12)</span>
249 <a name="l00227"></a>00227 uint8_t blank_[3];
250 <a name="l00228"></a>00228 } __attribute__ ((packed)) year_by_date;
251 <a name="l00229"></a>00229
252 <a name="l00230"></a>00230 struct YearByDay
253 <a name="l00231"></a>00231 {
254 <a name="l00232"></a>00232 uint8_t weekDay; <span class="comment">// day of week to recur on (0-6)</span>
255 <a name="l00233"></a>00233 uint8_t week; <span class="comment">// week of month (1 to 5)</span>
256 <a name="l00234"></a>00234 uint8_t month; <span class="comment">// (1-12)</span>
257 <a name="l00235"></a>00235 uint8_t blank[3];
258 <a name="l00236"></a>00236 } __attribute__ ((packed)) year_by_day;
259 <a name="l00237"></a>00237
260 <a name="l00238"></a>00238 struct Week
261 <a name="l00239"></a>00239 {
262 <a name="l00240"></a>00240 uint8_t days; <span class="comment">// bitmask</span>
263 <a name="l00241"></a>00241 <span class="preprocessor"> #define CRDF_WD_SUN 0x01</span>
264 <a name="l00242"></a>00242 <span class="preprocessor"></span><span class="preprocessor"> #define CRDF_WD_MON 0x02</span>
265 <a name="l00243"></a>00243 <span class="preprocessor"></span><span class="preprocessor"> #define CRDF_WD_TUE 0x04</span>
266 <a name="l00244"></a>00244 <span class="preprocessor"></span><span class="preprocessor"> #define CRDF_WD_WED 0x08</span>
267 <a name="l00245"></a>00245 <span class="preprocessor"></span><span class="preprocessor"> #define CRDF_WD_THU 0x10</span>
268 <a name="l00246"></a>00246 <span class="preprocessor"></span><span class="preprocessor"> #define CRDF_WD_FRI 0x20</span>
269 <a name="l00247"></a>00247 <span class="preprocessor"></span><span class="preprocessor"> #define CRDF_WD_SAT 0x40</span>
270 <a name="l00248"></a>00248 <span class="preprocessor"></span>
271 <a name="l00249"></a>00249 uint8_t blank[5];
272 <a name="l00250"></a>00250 } __attribute__ ((packed)) week;
273 <a name="l00251"></a>00251
274 <a name="l00252"></a>00252 } __attribute__ ((packed)) u;
275 <a name="l00253"></a>00253
276 <a name="l00254"></a>00254 } __attribute__ ((packed));
277 <a name="l00255"></a>00255 <span class="preprocessor">#define CALENDAR_RECURRENCE_DATA_FIELD_SIZE sizeof(Barry::Protocol::CalendarRecurrenceDataField)</span>
278 <a name="l00256"></a>00256 <span class="preprocessor"></span>
279 <a name="l00257"></a>00257 <span class="comment">//</span>
280 <a name="l00258"></a>00258 <span class="comment">// Calendar record: field constants</span>
281 <a name="l00259"></a>00259 <span class="comment">//</span>
282 <a name="l00260"></a>00260
283 <a name="l00261"></a>00261 <span class="preprocessor">#define CR_FREEBUSY_FREE 0</span>
284 <a name="l00262"></a>00262 <span class="preprocessor"></span><span class="preprocessor">#define CR_FREEBUSY_TENTATIVE 1</span>
285 <a name="l00263"></a>00263 <span class="preprocessor"></span><span class="preprocessor">#define CR_FREEBUSY_BUSY 2</span>
286 <a name="l00264"></a>00264 <span class="preprocessor"></span><span class="preprocessor">#define CR_FREEBUSY_OUT_OF_OFFICE 3</span>
287 <a name="l00265"></a>00265 <span class="preprocessor"></span><span class="preprocessor">#define CR_FREEBUSY_RANGE_LOW 0</span>
288 <a name="l00266"></a>00266 <span class="preprocessor"></span><span class="preprocessor">#define CR_FREEBUSY_RANGE_HIGH 3</span>
289 <a name="l00267"></a>00267 <span class="preprocessor"></span>
290 <a name="l00268"></a>00268 <span class="preprocessor">#define CR_CLASS_PUBLIC 0</span>
291 <a name="l00269"></a>00269 <span class="preprocessor"></span><span class="preprocessor">#define CR_CLASS_CONFIDENTIAL 1</span>
292 <a name="l00270"></a>00270 <span class="preprocessor"></span><span class="preprocessor">#define CR_CLASS_PRIVATE 2</span>
293 <a name="l00271"></a>00271 <span class="preprocessor"></span><span class="preprocessor">#define CR_CLASS_RANGE_LOW 0</span>
294 <a name="l00272"></a>00272 <span class="preprocessor"></span><span class="preprocessor">#define CR_CLASS_RANGE_HIGH 2</span>
295 <a name="l00273"></a>00273 <span class="preprocessor"></span>
296 <a name="l00274"></a>00274
297 <a name="l00275"></a>00275 <span class="comment">//</span>
298 <a name="l00276"></a>00276 <span class="comment">// Task record: field constants</span>
299 <a name="l00277"></a>00277 <span class="comment">//</span>
300 <a name="l00278"></a>00278
301 <a name="l00279"></a>00279 <span class="preprocessor">#define TR_ALARM_DATE 1</span>
302 <a name="l00280"></a>00280 <span class="preprocessor"></span><span class="preprocessor">#define TR_ALARM_RELATIVE 2</span>
303 <a name="l00281"></a>00281 <span class="preprocessor"></span><span class="preprocessor">#define TR_ALARM_RANGE_LOW 1</span>
304 <a name="l00282"></a>00282 <span class="preprocessor"></span><span class="preprocessor">#define TR_ALARM_RANGE_HIGH 2</span>
305 <a name="l00283"></a>00283 <span class="preprocessor"></span>
306 <a name="l00284"></a>00284 <span class="preprocessor">#define TR_PRIORITY_HIGH 0</span>
307 <a name="l00285"></a>00285 <span class="preprocessor"></span><span class="preprocessor">#define TR_PRIORITY_NORMAL 1</span>
308 <a name="l00286"></a>00286 <span class="preprocessor"></span><span class="preprocessor">#define TR_PRIORITY_LOW 2</span>
309 <a name="l00287"></a>00287 <span class="preprocessor"></span><span class="preprocessor">#define TR_PRIORITY_RANGE_LOW 0</span>
310 <a name="l00288"></a>00288 <span class="preprocessor"></span><span class="preprocessor">#define TR_PRIORITY_RANGE_HIGH 2</span>
311 <a name="l00289"></a>00289 <span class="preprocessor"></span>
312 <a name="l00290"></a>00290 <span class="preprocessor">#define TR_STATUS_NOT_STARTED 0</span>
313 <a name="l00291"></a>00291 <span class="preprocessor"></span><span class="preprocessor">#define TR_STATUS_IN_PROGRESS 1</span>
314 <a name="l00292"></a>00292 <span class="preprocessor"></span><span class="preprocessor">#define TR_STATUS_COMPLETED 2</span>
315 <a name="l00293"></a>00293 <span class="preprocessor"></span><span class="preprocessor">#define TR_STATUS_WAITING 3</span>
316 <a name="l00294"></a>00294 <span class="preprocessor"></span><span class="preprocessor">#define TR_STATUS_DEFERRED 4</span>
317 <a name="l00295"></a>00295 <span class="preprocessor"></span><span class="preprocessor">#define TR_STATUS_RANGE_LOW 0</span>
318 <a name="l00296"></a>00296 <span class="preprocessor"></span><span class="preprocessor">#define TR_STATUS_RANGE_HIGH 4</span>
319 <a name="l00297"></a>00297 <span class="preprocessor"></span>
320 <a name="l00298"></a>00298 <span class="comment">//</span>
321 <a name="l00299"></a>00299 <span class="comment">// Phone Call Logs record: field constants</span>
322 <a name="l00300"></a>00300 <span class="comment">//</span>
323 <a name="l00301"></a>00301 <span class="comment">//</span>
324 <a name="l00302"></a>00302 <span class="preprocessor">#define CLL_DIRECTION_RECEIVER 0</span>
325 <a name="l00303"></a>00303 <span class="preprocessor"></span><span class="preprocessor">#define CLL_DIRECTION_EMITTER 1</span>
326 <a name="l00304"></a>00304 <span class="preprocessor"></span><span class="preprocessor">#define CLL_DIRECTION_FAILED 2</span>
327 <a name="l00305"></a>00305 <span class="preprocessor"></span><span class="preprocessor">#define CLL_DIRECTION_MISSING 3</span>
328 <a name="l00306"></a>00306 <span class="preprocessor"></span><span class="preprocessor">#define CLL_DIRECTION_RANGE_LOW 0</span>
329 <a name="l00307"></a>00307 <span class="preprocessor"></span><span class="preprocessor">#define CLL_DIRECTION_RANGE_HIGH 3</span>
330 <a name="l00308"></a>00308 <span class="preprocessor"></span>
331 <a name="l00309"></a>00309 <span class="preprocessor">#define CLL_PHONETYPE_UNDEFINED 0</span>
332 <a name="l00310"></a>00310 <span class="preprocessor"></span><span class="preprocessor">#define CLL_PHONETYPE_OFFICE 1</span>
333 <a name="l00311"></a>00311 <span class="preprocessor"></span><span class="preprocessor">#define CLL_PHONETYPE_HOME 2</span>
334 <a name="l00312"></a>00312 <span class="preprocessor"></span><span class="preprocessor">#define CLL_PHONETYPE_MOBILE 3</span>
335 <a name="l00313"></a>00313 <span class="preprocessor"></span><span class="preprocessor">#define CLL_PHONETYPE_RANGE_LOW 0</span>
336 <a name="l00314"></a>00314 <span class="preprocessor"></span><span class="preprocessor">#define CLL_PHONETYPE_RANGE_HIGH 3</span>
337 <a name="l00315"></a>00315 <span class="preprocessor"></span>
338 <a name="l00316"></a>00316 <span class="comment">//</span>
339 <a name="l00317"></a>00317 <span class="comment">// Folder record: field constants</span>
340 <a name="l00318"></a>00318 <span class="comment">//</span>
341 <a name="l00319"></a>00319
342 <a name="l00320"></a>00320 <span class="preprocessor">#define FR_TYPE_SUBTREE 0x00</span>
343 <a name="l00321"></a>00321 <span class="preprocessor"></span><span class="preprocessor">#define FR_TYPE_DELETED 0x01</span>
344 <a name="l00322"></a>00322 <span class="preprocessor"></span><span class="preprocessor">#define FR_TYPE_INBOX 0x02</span>
345 <a name="l00323"></a>00323 <span class="preprocessor"></span><span class="preprocessor">#define FR_TYPE_OUTBOX 0x03</span>
346 <a name="l00324"></a>00324 <span class="preprocessor"></span><span class="preprocessor">#define FR_TYPE_SENT 0x04</span>
347 <a name="l00325"></a>00325 <span class="preprocessor"></span><span class="preprocessor">#define FR_TYPE_OTHER 0x05</span>
348 <a name="l00326"></a>00326 <span class="preprocessor"></span><span class="preprocessor">#define FR_TYPE_DRAFT 0x0a</span>
349 <a name="l00327"></a>00327 <span class="preprocessor"></span>
350 <a name="l00328"></a>00328 <span class="preprocessor">#define FR_STATUS_ORPHAN 0x50</span>
351 <a name="l00329"></a>00329 <span class="preprocessor"></span><span class="preprocessor">#define FR_STATUS_UNFILED 0x51</span>
352 <a name="l00330"></a>00330 <span class="preprocessor"></span><span class="preprocessor">#define FR_STATUS_FILED 0x52</span>
353 <a name="l00331"></a>00331 <span class="preprocessor"></span>
354 <a name="l00332"></a>00332 <span class="comment"></span>
355 <a name="l00333"></a>00333 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
356 <a name="l00334"></a>00334 <span class="comment"></span><span class="comment">// Packed field structures - odd format used with Service Book records</span>
357 <a name="l00335"></a>00335
358 <a name="l00336"></a>00336 <span class="keyword">struct </span>PackedField_02
359 <a name="l00337"></a>00337 {
360 <a name="l00338"></a>00338 uint8_t code;
361 <a name="l00339"></a>00339 uint8_t size;
362 <a name="l00340"></a>00340 uint8_t type;
363 <a name="l00341"></a>00341 uint8_t raw[1];
364 <a name="l00342"></a>00342 } __attribute__ ((packed));
365 <a name="l00343"></a>00343 <span class="preprocessor">#define PACKED_FIELD_02_HEADER_SIZE (sizeof(Barry::Protocol::PackedField_02) - 1)</span>
366 <a name="l00344"></a>00344 <span class="preprocessor"></span>
367 <a name="l00345"></a>00345 <span class="keyword">struct </span>PackedField_10
368 <a name="l00346"></a>00346 {
369 <a name="l00347"></a>00347 uint8_t type;
370 <a name="l00348"></a>00348 uint8_t size;
371 <a name="l00349"></a>00349 uint8_t raw[1];
372 <a name="l00350"></a>00350 } __attribute__ ((packed));
373 <a name="l00351"></a>00351 <span class="preprocessor">#define PACKED_FIELD_10_HEADER_SIZE (sizeof(Barry::Protocol::PackedField_10) - 1)</span>
374 <a name="l00352"></a>00352 <span class="preprocessor"></span>
375 <a name="l00353"></a>00353
376 <a name="l00354"></a>00354
377 <a name="l00355"></a>00355 <span class="comment"></span>
378 <a name="l00356"></a>00356 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
379 <a name="l00357"></a>00357 <span class="comment"></span><span class="comment">// Service Book field and record structures</span>
380 <a name="l00358"></a>00358
381 <a name="l00359"></a>00359 <span class="keyword">struct </span>ServiceBookConfigField
382 <a name="l00360"></a>00360 {
383 <a name="l00361"></a>00361 uint8_t format;
384 <a name="l00362"></a>00362 uint8_t fields[1];
385 <a name="l00363"></a>00363 } __attribute__ ((packed));
386 <a name="l00364"></a>00364 <span class="preprocessor">#define SERVICE_BOOK_CONFIG_FIELD_HEADER_SIZE (sizeof(Barry::Protocol::ServiceBookConfigField) - 1)</span>
387 <a name="l00365"></a>00365 <span class="preprocessor"></span>
388 <a name="l00366"></a>00366 <span class="comment"></span>
389 <a name="l00367"></a>00367 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
390 <a name="l00368"></a>00368 <span class="comment"></span><span class="comment">// DB Command Parameter structures</span>
391 <a name="l00369"></a>00369
392 <a name="l00370"></a>00370 <span class="keyword">struct </span>DBC_Record
393 <a name="l00371"></a>00371 {
394 <a name="l00372"></a>00372 uint16_t recordIndex; <span class="comment">// index comes from RecordStateTable</span>
395 <a name="l00373"></a>00373 uint8_t data[1];
396 <a name="l00374"></a>00374 } __attribute__ ((packed));
397 <a name="l00375"></a>00375 <span class="preprocessor">#define DBC_RECORD_HEADER_SIZE (sizeof(Barry::Protocol::DBC_Record) - 1)</span>
398 <a name="l00376"></a>00376 <span class="preprocessor"></span>
399 <a name="l00377"></a>00377 <span class="keyword">struct </span>DBC_RecordFlags
400 <a name="l00378"></a>00378 {
401 <a name="l00379"></a>00379 uint8_t unknown;
402 <a name="l00380"></a>00380 uint16_t index;
403 <a name="l00381"></a>00381 uint8_t unknown2[5];
404 <a name="l00382"></a>00382 } __attribute__ ((packed));
405 <a name="l00383"></a>00383 <span class="preprocessor">#define DBC_RECORD_FLAGS_SIZE (sizeof(Barry::Protocol::DBC_RecordFlags))</span>
406 <a name="l00384"></a>00384 <span class="preprocessor"></span>
407 <a name="l00385"></a>00385 <span class="keyword">struct </span>DBC_TaggedUpload
408 <a name="l00386"></a>00386 {
409 <a name="l00387"></a>00387 uint8_t rectype; <span class="comment">// it is unknown exactly what</span>
410 <a name="l00388"></a>00388 <span class="comment">// this field does, but it</span>
411 <a name="l00389"></a>00389 <span class="comment">// shows up here and in the</span>
412 <a name="l00390"></a>00390 <span class="comment">// RecordStateTable, and</span>
413 <a name="l00391"></a>00391 <span class="comment">// for some of the records</span>
414 <a name="l00392"></a>00392 <span class="comment">// they must match when writing</span>
415 <a name="l00393"></a>00393 uint32_t uniqueId;
416 <a name="l00394"></a>00394 uint8_t unknown2;
417 <a name="l00395"></a>00395 uint8_t data[1];
418 <a name="l00396"></a>00396 } __attribute__ ((packed));
419 <a name="l00397"></a>00397 <span class="preprocessor">#define DBC_TAGGED_UPLOAD_HEADER_SIZE (sizeof(Barry::Protocol::DBC_TaggedUpload) - 1)</span>
420 <a name="l00398"></a>00398 <span class="preprocessor"></span>
421 <a name="l00399"></a>00399 <span class="keyword">struct </span>DBC_IndexedUpload
422 <a name="l00400"></a>00400 {
423 <a name="l00401"></a>00401 uint8_t unknown; <span class="comment">// observed: 00 or 05</span>
424 <a name="l00402"></a>00402 uint16_t index;
425 <a name="l00403"></a>00403 uint8_t data[1];
426 <a name="l00404"></a>00404 } __attribute__ ((packed));
427 <a name="l00405"></a>00405 <span class="preprocessor">#define DBC_INDEXED_UPLOAD_HEADER_SIZE (sizeof(Barry::Protocol::DBC_IndexedUpload) - 1)</span>
428 <a name="l00406"></a>00406 <span class="preprocessor"></span>
429 <a name="l00407"></a>00407 <span class="keyword">struct </span>PasswordChallenge
430 <a name="l00408"></a>00408 {
431 <a name="l00409"></a>00409 uint8_t remaining_tries; <span class="comment">// number of password attempts</span>
432 <a name="l00410"></a>00410 <span class="comment">// the device will accept before</span>
433 <a name="l00411"></a>00411 <span class="comment">// committing suicide...</span>
434 <a name="l00412"></a>00412 <span class="comment">// starts at 10 and counts down</span>
435 <a name="l00413"></a>00413 <span class="comment">// on each bad password</span>
436 <a name="l00414"></a>00414 uint8_t unknown; <span class="comment">// observed as 0... probably just</span>
437 <a name="l00415"></a>00415 <span class="comment">// the top byte of a uint16</span>
438 <a name="l00416"></a>00416 <span class="comment">// remaining_tries, but I don't</span>
439 <a name="l00417"></a>00417 <span class="comment">// want to take that chance</span>
440 <a name="l00418"></a>00418 uint16_t param; <span class="comment">// seems to be a secondary command</span>
441 <a name="l00419"></a>00419 <span class="comment">// of some kind, observed as 0x14</span>
442 <a name="l00420"></a>00420 <span class="comment">// or 0x04, but purpose unknown</span>
443 <a name="l00421"></a>00421 <span class="comment">// possibly a send/receive flag</span>
444 <a name="l00422"></a>00422 <span class="comment">// bit (0x10/0x00)</span>
445 <a name="l00423"></a>00423 <span class="keyword">union </span>Hash
446 <a name="l00424"></a>00424 {
447 <a name="l00425"></a>00425 uint32_t seed;
448 <a name="l00426"></a>00426 uint8_t hash[20];
449 <a name="l00427"></a>00427 } __attribute__ ((packed)) u;
450 <a name="l00428"></a>00428
451 <a name="l00429"></a>00429 } __attribute__ ((packed));
452 <a name="l00430"></a>00430 <span class="preprocessor">#define PASSWORD_CHALLENGE_HEADER_SIZE (sizeof(Barry::Protocol::PasswordChallenge) - sizeof(Barry::Protocol::PasswordChallenge::Hash))</span>
453 <a name="l00431"></a>00431 <span class="preprocessor"></span><span class="preprocessor">#define PASSWORD_CHALLENGE_SEED_SIZE (PASSWORD_CHALLENGE_HEADER_SIZE + sizeof(uint32_t))</span>
454 <a name="l00432"></a>00432 <span class="preprocessor"></span><span class="preprocessor">#define PASSWORD_CHALLENGE_SIZE (sizeof(Barry::Protocol::PasswordChallenge))</span>
455 <a name="l00433"></a>00433 <span class="preprocessor"></span>
456 <a name="l00434"></a>00434 <span class="keyword">struct </span>AttributeFetch
457 <a name="l00435"></a>00435 {
458 <a name="l00436"></a>00436 uint16_t object;
459 <a name="l00437"></a>00437 uint16_t attribute;
460 <a name="l00438"></a>00438 uint8_t raw[1]; <span class="comment">// used only in response</span>
461 <a name="l00439"></a>00439 } __attribute__ ((packed));
462 <a name="l00440"></a>00440 <span class="preprocessor">#define ATTRIBUTE_FETCH_COMMAND_SIZE (sizeof(Barry::Protocol::AttributeFetch) - 1)</span>
463 <a name="l00441"></a>00441 <span class="preprocessor"></span>
464 <a name="l00442"></a>00442 <span class="keyword">struct </span>ModeSelect
465 <a name="l00443"></a>00443 {
466 <a name="l00444"></a>00444 uint8_t name[16];
467 <a name="l00445"></a>00445 <span class="keyword">struct </span>ResponseBlock
468 <a name="l00446"></a>00446 {
469 <a name="l00447"></a>00447 uint8_t unknown[20];
470 <a name="l00448"></a>00448 } __attribute__ ((packed)) response;
471 <a name="l00449"></a>00449 } __attribute__ ((packed));
472 <a name="l00450"></a>00450
473 <a name="l00451"></a>00451 struct Echo
474 <a name="l00452"></a>00452 {
475 <a name="l00453"></a>00453 uint64_t ticks; <span class="comment">// number of microseconds since</span>
476 <a name="l00454"></a>00454 <span class="comment">// host system startup</span>
477 <a name="l00455"></a>00455 } __attribute__ ((packed));
478 <a name="l00456"></a>00456 <span class="preprocessor">#define ECHO_COMMAND_SIZE (sizeof(Barry::Protocol::Echo))</span>
479 <a name="l00457"></a>00457 <span class="preprocessor"></span>
480 <a name="l00458"></a>00458 <span class="comment"></span>
481 <a name="l00459"></a>00459 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
482 <a name="l00460"></a>00460 <span class="comment"></span><span class="comment">// Protocol command structures</span>
483 <a name="l00461"></a>00461
484 <a name="l00462"></a>00462 <span class="keyword">struct </span>SocketCommand
485 <a name="l00463"></a>00463 {
486 <a name="l00464"></a>00464 uint16_t socket;
487 <a name="l00465"></a>00465 uint8_t sequence; <span class="comment">// incremented on each socket 0</span>
488 <a name="l00466"></a>00466 <span class="comment">// communication, replies return</span>
489 <a name="l00467"></a>00467 <span class="comment">// the same number from command</span>
490 <a name="l00468"></a>00468
491 <a name="l00469"></a>00469 <span class="keyword">union </span>PacketData
492 <a name="l00470"></a>00470 {
493 <a name="l00471"></a>00471
494 <a name="l00472"></a>00472 PasswordChallenge password;
495 <a name="l00473"></a>00473 AttributeFetch fetch;
496 <a name="l00474"></a>00474 ModeSelect mode;
497 <a name="l00475"></a>00475 uint8_t raw[1];
498 <a name="l00476"></a>00476 Echo echo;
499 <a name="l00477"></a>00477
500 <a name="l00478"></a>00478 } __attribute__ ((packed)) u;
501 <a name="l00479"></a>00479 } __attribute__ ((packed));
502 <a name="l00480"></a>00480 <span class="preprocessor">#define SOCKET_COMMAND_HEADER_SIZE (sizeof(Barry::Protocol::SocketCommand) - sizeof(Barry::Protocol::SocketCommand::PacketData))</span>
503 <a name="l00481"></a>00481 <span class="preprocessor"></span>
504 <a name="l00482"></a>00482 <span class="keyword">struct </span>SequenceCommand
505 <a name="l00483"></a>00483 {
506 <a name="l00484"></a>00484 uint8_t unknown1;
507 <a name="l00485"></a>00485 uint8_t unknown2;
508 <a name="l00486"></a>00486 uint8_t unknown3;
509 <a name="l00487"></a>00487 uint32_t sequenceId;
510 <a name="l00488"></a>00488 } __attribute__ ((packed));
511 <a name="l00489"></a>00489
512 <a name="l00490"></a>00490 <span class="keyword">struct </span>DBCommand
513 <a name="l00491"></a>00491 {
514 <a name="l00492"></a>00492 uint8_t operation; <span class="comment">// see below</span>
515 <a name="l00493"></a>00493 uint16_t databaseId; <span class="comment">// value from the Database Database</span>
516 <a name="l00494"></a>00494
517 <a name="l00495"></a>00495 <span class="keyword">union </span>Parameters
518 <a name="l00496"></a>00496 {
519 <a name="l00497"></a>00497
520 <a name="l00498"></a>00498 DBC_Record record;
521 <a name="l00499"></a>00499 DBC_RecordFlags flags;
522 <a name="l00500"></a>00500 DBC_TaggedUpload tag_upload;
523 <a name="l00501"></a>00501 DBC_IndexedUpload index_upload;
524 <a name="l00502"></a>00502 uint8_t raw[1];
525 <a name="l00503"></a>00503
526 <a name="l00504"></a>00504 } __attribute__ ((packed)) u;
527 <a name="l00505"></a>00505 } __attribute__ ((packed));
528 <a name="l00506"></a>00506 <span class="preprocessor">#define DB_COMMAND_HEADER_SIZE (sizeof(Barry::Protocol::DBCommand) - sizeof(Barry::Protocol::DBCommand::Parameters))</span>
529 <a name="l00507"></a>00507 <span class="preprocessor"></span>
530 <a name="l00508"></a>00508
531 <a name="l00509"></a>00509 <span class="comment"></span>
532 <a name="l00510"></a>00510 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
533 <a name="l00511"></a>00511 <span class="comment"></span><span class="comment">// Protocol response parameter structures</span>
534 <a name="l00512"></a>00512
535 <a name="l00513"></a>00513 <span class="keyword">struct </span>DBR_OldDBDBRecord
536 <a name="l00514"></a>00514 {
537 <a name="l00515"></a>00515 uint16_t count; <span class="comment">// number of fields in record</span>
538 <a name="l00516"></a>00516 OldDBDBField field[1];
539 <a name="l00517"></a>00517 } __attribute__ ((packed));
540 <a name="l00518"></a>00518 <span class="preprocessor">#define OLD_DBDB_RECORD_HEADER_SIZE (sizeof(Barry::Protocol::DBR_OldDBDBRecord) - sizeof(Barry::Protocol::OldDBDBField))</span>
541 <a name="l00519"></a>00519 <span class="preprocessor"></span>
542 <a name="l00520"></a>00520 <span class="keyword">struct </span>DBR_DBDBRecord
543 <a name="l00521"></a>00521 {
544 <a name="l00522"></a>00522 uint16_t count;
545 <a name="l00523"></a>00523 uint8_t unknown[3];
546 <a name="l00524"></a>00524 DBDBField field[1];
547 <a name="l00525"></a>00525 } __attribute__ ((packed));
548 <a name="l00526"></a>00526 <span class="preprocessor">#define DBDB_RECORD_HEADER_SIZE (sizeof(Barry::Protocol::DBR_DBDBRecord) - sizeof(Barry::Protocol::DBDBField))</span>
549 <a name="l00527"></a>00527 <span class="preprocessor"></span>
550 <a name="l00528"></a>00528 <span class="comment">// Records with a uniqueId. This covers the following records:</span>
551 <a name="l00529"></a>00529 <span class="comment">//</span>
552 <a name="l00530"></a>00530 <span class="comment">// Old Contact records</span>
553 <a name="l00531"></a>00531 <span class="comment">// Old Service Book records</span>
554 <a name="l00532"></a>00532 <span class="comment">// Old Calendar records</span>
555 <a name="l00533"></a>00533 <span class="comment">//</span>
556 <a name="l00534"></a>00534 <span class="keyword">struct </span>DBR_OldTaggedRecord
557 <a name="l00535"></a>00535 {
558 <a name="l00536"></a>00536 uint8_t rectype;
559 <a name="l00537"></a>00537 uint16_t index;
560 <a name="l00538"></a>00538 uint32_t uniqueId;
561 <a name="l00539"></a>00539 uint8_t unknown2;
562 <a name="l00540"></a>00540
563 <a name="l00541"></a>00541 <span class="keyword">union </span>TaggedData
564 <a name="l00542"></a>00542 {
565 <a name="l00543"></a>00543 CommonField field[1];
566 <a name="l00544"></a>00544 } __attribute__ ((packed)) u;
567 <a name="l00545"></a>00545 } __attribute__ ((packed));
568 <a name="l00546"></a>00546 <span class="preprocessor">#define DBR_OLD_TAGGED_RECORD_HEADER_SIZE (sizeof(Barry::Protocol::DBR_OldTaggedRecord) - sizeof(Barry::Protocol::DBR_OldTaggedRecord::TaggedData))</span>
569 <a name="l00547"></a>00547 <span class="preprocessor"></span>
570 <a name="l00548"></a>00548 <span class="keyword">struct </span>MessageRecord
571 <a name="l00549"></a>00549 {
572 <a name="l00550"></a>00550 uint8_t field1; <span class="comment">// always 'j'</span>
573 <a name="l00551"></a>00551 uint32_t field2; <span class="comment">// always 0x00000000</span>
574 <a name="l00552"></a>00552 uint32_t flags; <span class="comment">// flags</span>
575 <a name="l00553"></a>00553 uint32_t field4; <span class="comment">// normal email and pin recv this is 0x7ff</span>
576 <a name="l00554"></a>00554 <span class="comment">// changes on sent and reply to 0x01ffffff</span>
577 <a name="l00555"></a>00555 <span class="comment">// and 0x003fffff on pin send</span>
578 <a name="l00556"></a>00556 uint32_t field5; <span class="comment">// always 0x00000000</span>
579 <a name="l00557"></a>00557 uint32_t field6; <span class="comment">// always 0x00000000</span>
580 <a name="l00558"></a>00558 uint32_t field7; <span class="comment">// always 0x00000000</span>
581 <a name="l00559"></a>00559 uint32_t field8; <span class="comment">// always 0x00000000</span>
582 <a name="l00560"></a>00560 uint16_t field9; <span class="comment">// always 0x0000</span>
583 <a name="l00561"></a>00561
584 <a name="l00562"></a>00562 uint16_t dateReceived; <span class="comment">// the first two of these time fields are always the same</span>
585 <a name="l00563"></a>00563 uint16_t timeReceived; <span class="comment">//</span>
586 <a name="l00564"></a>00564 uint16_t dateDuplicate; <span class="comment">// On mail sent from the BB all three fields are identical</span>
587 <a name="l00565"></a>00565 uint16_t timeDuplicate; <span class="comment">// (time sent)</span>
588 <a name="l00566"></a>00566 uint16_t dateSent;
589 <a name="l00567"></a>00567 uint16_t timeSent;
590 <a name="l00568"></a>00568
591 <a name="l00569"></a>00569 uint16_t priority; <span class="comment">// priority field</span>
592 <a name="l00570"></a>00570 uint32_t field14; <span class="comment">// always 0x00000000</span>
593 <a name="l00571"></a>00571 uint32_t field15; <span class="comment">// always 0x00000000</span>
594 <a name="l00572"></a>00572 uint16_t field16; <span class="comment">// always 0x0000</span>
595 <a name="l00573"></a>00573 uint32_t field13; <span class="comment">// PIN reply 0x00000000 other time 0xffffffff or 0xfffffffe</span>
596 <a name="l00574"></a>00574 uint16_t messageSize; <span class="comment">// Message size, 0x0000 if Reply or Saved, 0xffff if below ????</span>
597 <a name="l00575"></a>00575 uint32_t field18; <span class="comment">// 0x0's and 0xF'x</span>
598 <a name="l00576"></a>00576 uint32_t field19; <span class="comment">// 0x0's and 0xF's</span>
599 <a name="l00577"></a>00577 uint16_t field20; <span class="comment">// always 0x0000</span>
600 <a name="l00578"></a>00578 uint16_t field21; <span class="comment">// 0x01 unless PIN reply then 0x00</span>
601 <a name="l00579"></a>00579 uint32_t inReplyTo; <span class="comment">// reply to message?</span>
602 <a name="l00580"></a>00580 uint32_t field22; <span class="comment">// always 0x00000000</span>
603 <a name="l00581"></a>00581 uint16_t field23; <span class="comment">// FIXME</span>
604 <a name="l00582"></a>00582
605 <a name="l00583"></a>00583 uint32_t folderOne; <span class="comment">// these are the 'folders' the message is in</span>
606 <a name="l00584"></a>00584 uint32_t folderTwo; <span class="comment">//</span>
607 <a name="l00585"></a>00585
608 <a name="l00586"></a>00586 uint16_t replyMessageFlags; <span class="comment">// 0xfffe on recvd messages</span>
609 <a name="l00587"></a>00587 <span class="comment">// 0x001b on reply</span>
610 <a name="l00588"></a>00588 <span class="comment">// 0x0015 on send</span>
611 <a name="l00589"></a>00589 <span class="comment">// 0x3 pin send</span>
612 <a name="l00590"></a>00590 <span class="comment">// 0x2 on pin recv</span>
613 <a name="l00591"></a>00591 uint16_t field27; <span class="comment">// set to 0x00000004 on PIN reply, 0x00000005 otherwise</span>
614 <a name="l00592"></a>00592 uint32_t headerUID; <span class="comment">// yet another copy of the UID (RecId)</span>
615 <a name="l00593"></a>00593
616 <a name="l00594"></a>00594 uint32_t field29; <span class="comment">// always 0x00000000</span>
617 <a name="l00595"></a>00595 uint16_t field30; <span class="comment">// always 0x0002</span>
618 <a name="l00596"></a>00596 uint16_t field31; <span class="comment">// always 0x00000000</span>
619 <a name="l00597"></a>00597 uint16_t field32; <span class="comment">// always 0x0004</span>
620 <a name="l00598"></a>00598 uint16_t field34; <span class="comment">// always 0x0000</span>
621 <a name="l00599"></a>00599 uint8_t field33; <span class="comment">// always 'd'</span>
622 <a name="l00600"></a>00600 uint32_t timeBlock; <span class="comment">// FIXME</span>
623 <a name="l00601"></a>00601 CommonField field[1];
624 <a name="l00602"></a>00602 } __attribute__ ((packed));
625 <a name="l00603"></a>00603 <span class="preprocessor">#define MESSAGE_RECORD_HEADER_SIZE (sizeof(Barry::Protocol::MessageRecord) - sizeof(Barry::Protocol::CommonField))</span>
626 <a name="l00604"></a>00604 <span class="preprocessor"></span>
627 <a name="l00605"></a>00605
628 <a name="l00606"></a>00606 <span class="comment"></span>
629 <a name="l00607"></a>00607 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
630 <a name="l00608"></a>00608 <span class="comment"></span><span class="comment">// Protocol response structures</span>
631 <a name="l00609"></a>00609
632 <a name="l00610"></a>00610 <span class="keyword">struct </span>DBResponse
633 <a name="l00611"></a>00611 {
634 <a name="l00612"></a>00612 uint8_t operation;
635 <a name="l00613"></a>00613
636 <a name="l00614"></a>00614 <span class="keyword">union </span>Parameters
637 <a name="l00615"></a>00615 {
638 <a name="l00616"></a>00616
639 <a name="l00617"></a>00617 DBR_OldTaggedRecord tagged;
640 <a name="l00618"></a>00618 DBR_OldDBDBRecord old_dbdb;
641 <a name="l00619"></a>00619 DBR_DBDBRecord dbdb;
642 <a name="l00620"></a>00620
643 <a name="l00621"></a>00621 } __attribute__ ((packed)) u;
644 <a name="l00622"></a>00622
645 <a name="l00623"></a>00623 } __attribute__ ((packed));
646 <a name="l00624"></a>00624 <span class="preprocessor">#define DB_RESPONSE_HEADER_SIZE (sizeof(Barry::Protocol::DBResponse) - sizeof(Barry::Protocol::DBResponse::Parameters))</span>
647 <a name="l00625"></a>00625 <span class="preprocessor"></span>
648 <a name="l00626"></a>00626
649 <a name="l00627"></a>00627 <span class="comment"></span>
650 <a name="l00628"></a>00628 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
651 <a name="l00629"></a>00629 <span class="comment"></span><span class="comment">// Database access command structure</span>
652 <a name="l00630"></a>00630
653 <a name="l00631"></a>00631 <span class="comment">// even fragmented packets have a tableCmd</span>
654 <a name="l00632"></a>00632 <span class="keyword">struct </span>DBAccess
655 <a name="l00633"></a>00633 {
656 <a name="l00634"></a>00634 uint8_t tableCmd;
657 <a name="l00635"></a>00635
658 <a name="l00636"></a>00636 <span class="keyword">union </span>DBData
659 <a name="l00637"></a>00637 {
660 <a name="l00638"></a>00638 DBCommand command;
661 <a name="l00639"></a>00639 DBResponse response;
662 <a name="l00640"></a>00640 CommandTableField table[1];
663 <a name="l00641"></a>00641 uint8_t return_code;
664 <a name="l00642"></a>00642 uint8_t fragment[1];
665 <a name="l00643"></a>00643
666 <a name="l00644"></a>00644 } __attribute__ ((packed)) u;
667 <a name="l00645"></a>00645 } __attribute__ ((packed));
668 <a name="l00646"></a>00646 <span class="preprocessor">#define SB_DBACCESS_HEADER_SIZE (sizeof(Barry::Protocol::DBAccess) - sizeof(Barry::Protocol::DBAccess::DBData))</span>
669 <a name="l00647"></a>00647 <span class="preprocessor"></span><span class="preprocessor">#define SB_DBACCESS_RETURN_CODE_SIZE (1)</span>
670 <a name="l00648"></a>00648 <span class="preprocessor"></span>
671 <a name="l00649"></a>00649
672 <a name="l00650"></a>00650 <span class="comment"></span>
673 <a name="l00651"></a>00651 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
674 <a name="l00652"></a>00652 <span class="comment"></span><span class="comment">// Javaloader protocol structure</span>
675 <a name="l00653"></a>00653
676 <a name="l00654"></a>00654 <span class="keyword">struct </span>JLDirEntry
677 <a name="l00655"></a>00655 {
678 <a name="l00656"></a>00656 uint16_t unknown;
679 <a name="l00657"></a>00657 uint32_t timestamp;
680 <a name="l00658"></a>00658 uint16_t filename_size;
681 <a name="l00659"></a>00659 uint8_t filename[1];
682 <a name="l00660"></a>00660 <span class="comment">// the rest of the packet is variable length</span>
683 <a name="l00661"></a>00661 <span class="comment">// another string for version, then:</span>
684 <a name="l00662"></a>00662 <span class="comment">// uint32_t cod_size;</span>
685 <a name="l00663"></a>00663
686 <a name="l00664"></a>00664 } __attribute__ ((packed));
687 <a name="l00665"></a>00665 <span class="preprocessor">#define SB_JLDIRENTRY_HEADER_SIZE (sizeof(Barry::Protocol::JLDirEntry) - 1)</span>
688 <a name="l00666"></a>00666 <span class="preprocessor"></span>
689 <a name="l00667"></a>00667 <span class="keyword">struct </span>JLCommand
690 <a name="l00668"></a>00668 {
691 <a name="l00669"></a>00669 uint8_t command;
692 <a name="l00670"></a>00670 uint8_t unknown; <span class="comment">// nearly always 0, might be top half of command</span>
693 <a name="l00671"></a>00671 uint16_t size;
694 <a name="l00672"></a>00672 } __attribute__ ((packed));
695 <a name="l00673"></a>00673 <span class="preprocessor">#define SB_JLCOMMAND_HEADER_SIZE (sizeof(Barry::Protocol::JLCommand))</span>
696 <a name="l00674"></a>00674 <span class="preprocessor"></span>
697 <a name="l00675"></a>00675 <span class="keyword">struct </span>JLResponse
698 <a name="l00676"></a>00676 {
699 <a name="l00677"></a>00677 uint8_t command;
700 <a name="l00678"></a>00678 uint8_t unknown;
701 <a name="l00679"></a>00679 uint16_t expect;
702 <a name="l00680"></a>00680 } __attribute__ ((packed));
703 <a name="l00681"></a>00681 <span class="preprocessor">#define SB_JLRESPONSE_HEADER_SIZE (sizeof(Barry::Protocol::JLResponse))</span>
704 <a name="l00682"></a>00682 <span class="preprocessor"></span>
705 <a name="l00683"></a>00683 <span class="keyword">struct </span>JLScreenInfo
706 <a name="l00684"></a>00684 {
707 <a name="l00685"></a>00685 uint16_t unknown1;
708 <a name="l00686"></a>00686 uint16_t unknown2;
709 <a name="l00687"></a>00687 uint16_t unknown3;
710 <a name="l00688"></a>00688 uint16_t width;
711 <a name="l00689"></a>00689 uint16_t height;
712 <a name="l00690"></a>00690 uint16_t unknown4;
713 <a name="l00691"></a>00691 uint16_t unknown5;
714 <a name="l00692"></a>00692 uint16_t unknown6;
715 <a name="l00693"></a>00693 } __attribute__ ((packed));
716 <a name="l00694"></a>00694 <span class="preprocessor">#define SB_JLSCREENINFO_SIZE (sizeof(Barry::Protocol::JLScreenInfo))</span>
717 <a name="l00695"></a>00695 <span class="preprocessor"></span>
718 <a name="l00696"></a>00696 <span class="keyword">struct </span>JLEventlogEntry
719 <a name="l00697"></a>00697 {
720 <a name="l00698"></a>00698 uint16_t size;
721 <a name="l00699"></a>00699 <span class="comment">// remainder of packet is variable</span>
722 <a name="l00700"></a>00700 <span class="comment">// it contains the log data as an ASCII (UTF-8?) string</span>
723 <a name="l00701"></a>00701 } __attribute__ ((packed));
724 <a name="l00702"></a>00702 <span class="preprocessor">#define SB_JLEVENTLOG_ENTRY_HEADER_SIZE (sizeof(Barry::Protocol::JLEventlogEntry))</span>
725 <a name="l00703"></a>00703 <span class="preprocessor"></span>
726 <a name="l00704"></a>00704 <span class="keyword">struct </span>JLDeviceInfo
727 <a name="l00705"></a>00705 {
728 <a name="l00706"></a>00706 uint32_t hardware_id;
729 <a name="l00707"></a>00707 uint32_t pin;
730 <a name="l00708"></a>00708 uint32_t os_version;
731 <a name="l00709"></a>00709 uint32_t vm_version;
732 <a name="l00710"></a>00710 uint32_t radio_id;
733 <a name="l00711"></a>00711 uint32_t vendor_id;
734 <a name="l00712"></a>00712 uint32_t active_wafs;
735 <a name="l00713"></a>00713 <span class="comment">// older devices (such as 7130) don't this extra data in the</span>
736 <a name="l00714"></a>00714 <span class="comment">// device info packet and will therefore fail the size check</span>
737 <a name="l00715"></a>00715 <span class="comment">//uint8_t raw[4];</span>
738 <a name="l00716"></a>00716 } __attribute__ ((packed));
739 <a name="l00717"></a>00717 <span class="preprocessor">#define SB_JLDEVICEINFO_SIZE (sizeof(Barry::Protocol::JLDeviceInfo))</span>
740 <a name="l00718"></a>00718 <span class="preprocessor"></span>
741 <a name="l00719"></a>00719 <span class="keyword">struct </span>JLPacket
742 <a name="l00720"></a>00720 {
743 <a name="l00721"></a>00721 uint16_t socket;
744 <a name="l00722"></a>00722 uint16_t size; <span class="comment">// total size of data packet</span>
745 <a name="l00723"></a>00723
746 <a name="l00724"></a>00724 <span class="keyword">union </span>PacketData
747 <a name="l00725"></a>00725 {
748 <a name="l00726"></a>00726 JLCommand command;
749 <a name="l00727"></a>00727 JLResponse response;
750 <a name="l00728"></a>00728 JLScreenInfo screeninfo;
751 <a name="l00729"></a>00729 JLEventlogEntry logentry;
752 <a name="l00730"></a>00730 JLDeviceInfo devinfo;
753 <a name="l00731"></a>00731 uint8_t raw[1];
754 <a name="l00732"></a>00732 <span class="keywordtype">char</span> filename[1];
755 <a name="l00733"></a>00733 uint32_t cod_size;
756 <a name="l00734"></a>00734 uint32_t timestamp;
757 <a name="l00735"></a>00735 uint16_t id;
758 <a name="l00736"></a>00736 } __attribute__ ((packed)) u;
759 <a name="l00737"></a>00737
760 <a name="l00738"></a>00738 } __attribute__ ((packed));
761 <a name="l00739"></a>00739 <span class="preprocessor">#define SB_JLPACKET_HEADER_SIZE (sizeof(Barry::Protocol::JLPacket) - sizeof(Barry::Protocol::JLPacket::PacketData))</span>
762 <a name="l00740"></a>00740 <span class="preprocessor"></span><span class="comment"></span>
763 <a name="l00741"></a>00741 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
764 <a name="l00742"></a>00742 <span class="comment"></span><span class="comment">// Main packet struct</span>
765 <a name="l00743"></a>00743
766 <a name="l00744"></a>00744 <span class="keyword">struct </span>Packet
767 <a name="l00745"></a>00745 {
768 <a name="l00746"></a>00746 uint16_t socket; <span class="comment">// socket ID... 0 exists by default</span>
769 <a name="l00747"></a>00747 uint16_t size; <span class="comment">// total size of data packet</span>
770 <a name="l00748"></a>00748 uint8_t command;
771 <a name="l00749"></a>00749
772 <a name="l00750"></a>00750 <span class="keyword">union </span>PacketData
773 <a name="l00751"></a>00751 {
774 <a name="l00752"></a>00752
775 <a name="l00753"></a>00753 SocketCommand socket;
776 <a name="l00754"></a>00754 SequenceCommand sequence;
777 <a name="l00755"></a>00755 DBAccess db;
778 <a name="l00756"></a>00756 uint8_t raw[1];
779 <a name="l00757"></a>00757
780 <a name="l00758"></a>00758 } __attribute__ ((packed)) u;
781 <a name="l00759"></a>00759 } __attribute__ ((packed));
782 <a name="l00760"></a>00760 <span class="preprocessor">#define SB_PACKET_HEADER_SIZE (sizeof(Barry::Protocol::Packet) - sizeof(Barry::Protocol::Packet::PacketData))</span>
783 <a name="l00761"></a>00761 <span class="preprocessor"></span>
784 <a name="l00762"></a>00762 <span class="comment">// WARNING : For JavaLoader we have some packet with 5 size !</span>
785 <a name="l00763"></a>00763 <span class="preprocessor">#define MIN_PACKET_SIZE 5</span>
786 <a name="l00764"></a>00764 <span class="preprocessor"></span><span class="preprocessor">#define MIN_PACKET_DATA_SIZE 4</span>
787 <a name="l00765"></a>00765 <span class="preprocessor"></span>
788 <a name="l00766"></a>00766
789 <a name="l00767"></a>00767 <span class="comment">// maximum sizes</span>
790 <a name="l00768"></a>00768 <span class="preprocessor">#define MAX_PACKET_SIZE 0x400 // anything beyond this needs to be fragmented</span>
791 <a name="l00769"></a>00769 <span class="preprocessor"></span><span class="preprocessor">#define MAX_PACKET_DATA_SIZE 0x7FC // for data packet (JavaLoader)</span>
792 <a name="l00770"></a>00770 <span class="preprocessor"></span><span class="comment"></span>
793 <a name="l00771"></a>00771 <span class="comment">/////////////////////////////////////////////////////////////////////////////</span>
794 <a name="l00772"></a>00772 <span class="comment"></span><span class="comment">//</span>
795 <a name="l00773"></a>00773 <span class="comment">// various useful sizes</span>
796 <a name="l00774"></a>00774 <span class="comment">//</span>
797 <a name="l00775"></a>00775
798 <a name="l00776"></a>00776 <span class="preprocessor">#define SB_PACKET_DBACCESS_HEADER_SIZE (SB_PACKET_HEADER_SIZE + SB_DBACCESS_HEADER_SIZE)</span>
799 <a name="l00777"></a>00777 <span class="preprocessor"></span><span class="preprocessor">#define SB_FRAG_HEADER_SIZE SB_PACKET_DBACCESS_HEADER_SIZE</span>
800 <a name="l00778"></a>00778 <span class="preprocessor"></span>
801 <a name="l00779"></a>00779 <span class="preprocessor">#define SB_PACKET_COMMAND_HEADER_SIZE (SB_PACKET_DBACCESS_HEADER_SIZE + DB_COMMAND_HEADER_SIZE)</span>
802 <a name="l00780"></a>00780 <span class="preprocessor"></span><span class="preprocessor">#define SB_PACKET_RESPONSE_HEADER_SIZE (SB_PACKET_DBACCESS_HEADER_SIZE + DB_RESPONSE_HEADER_SIZE)</span>
803 <a name="l00781"></a>00781 <span class="preprocessor"></span>
804 <a name="l00782"></a>00782 <span class="preprocessor">#define SB_PACKET_DBDB_HEADER_SIZE (SB_PACKET_RESPONSE_HEADER_SIZE + DBDB_RECORD_HEADER_SIZE)</span>
805 <a name="l00783"></a>00783 <span class="preprocessor"></span><span class="preprocessor">#define SB_PACKET_OLD_DBDB_HEADER_SIZE (SB_PACKET_RESPONSE_HEADER_SIZE + OLD_DBDB_RECORD_HEADER_SIZE)</span>
806 <a name="l00784"></a>00784 <span class="preprocessor"></span>
807 <a name="l00785"></a>00785 <span class="preprocessor">#define SB_PACKET_UPLOAD_HEADER_SIZE (SB_PACKET_DBACCESS_HEADER_SIZE + UPLOAD_HEADER_SIZE)</span>
808 <a name="l00786"></a>00786 <span class="preprocessor"></span>
809 <a name="l00787"></a>00787 <span class="preprocessor">#define SB_SEQUENCE_PACKET_SIZE (SB_PACKET_HEADER_SIZE + sizeof(Barry::Protocol::SequenceCommand))</span>
810 <a name="l00788"></a>00788 <span class="preprocessor"></span><span class="preprocessor">#define SB_SOCKET_PACKET_HEADER_SIZE (SB_PACKET_HEADER_SIZE + SOCKET_COMMAND_HEADER_SIZE)</span>
811 <a name="l00789"></a>00789 <span class="preprocessor"></span><span class="preprocessor">#define SB_MODE_PACKET_COMMAND_SIZE (SB_SOCKET_PACKET_HEADER_SIZE + sizeof(Barry::Protocol::ModeSelect) - sizeof(Barry::Protocol::ModeSelect::ResponseBlock))</span>
812 <a name="l00790"></a>00790 <span class="preprocessor"></span><span class="preprocessor">#define SB_MODE_PACKET_RESPONSE_SIZE (SB_SOCKET_PACKET_HEADER_SIZE + sizeof(Barry::Protocol::ModeSelect))</span>
813 <a name="l00791"></a>00791 <span class="preprocessor"></span>
814 <a name="l00792"></a>00792
815 <a name="l00793"></a>00793 <span class="comment">// Macros</span>
816 <a name="l00794"></a>00794 <span class="preprocessor">#define COMMAND(data) (((const Barry::Protocol::Packet *)data.GetData())-&gt;command)</span>
817 <a name="l00795"></a>00795 <span class="preprocessor"></span><span class="preprocessor">#define IS_COMMAND(data, cmd) (COMMAND(data) == cmd)</span>
818 <a name="l00796"></a>00796 <span class="preprocessor"></span><span class="preprocessor">#define MAKE_PACKET(var, data) const Barry::Protocol::Packet *var = (const Barry::Protocol::Packet *) (data).GetData()</span>
819 <a name="l00797"></a>00797 <span class="preprocessor"></span><span class="preprocessor">#define MAKE_JLPACKET(var, data) const Barry::Protocol::JLPacket *var = (const Barry::Protocol::JLPacket *) (data).GetData()</span>
820 <a name="l00798"></a>00798 <span class="preprocessor"></span><span class="preprocessor">#define MAKE_PACKETPTR_BUF(var, ptr) Barry::Protocol::Packet *var = (Barry::Protocol::Packet *)ptr</span>
821 <a name="l00799"></a>00799 <span class="preprocessor"></span><span class="preprocessor">#define MAKE_JLPACKETPTR_BUF(var, ptr) Barry::Protocol::JLPacket *var = (Barry::Protocol::JLPacket *)ptr</span>
822 <a name="l00800"></a>00800 <span class="preprocessor"></span><span class="preprocessor">#define MAKE_RECORD(type,var,data,off) type *var = (type *) ((data).GetData() + (off))</span>
823 <a name="l00801"></a>00801 <span class="preprocessor"></span><span class="preprocessor">#define MAKE_RECORD_PTR(type,var,data,off) type *var = (type *) ((data) + (off))</span>
824 <a name="l00802"></a>00802 <span class="preprocessor"></span>
825 <a name="l00803"></a>00803 <span class="comment">// fragmentation protocol</span>
826 <a name="l00804"></a>00804 <span class="comment">// send DATA first, then keep sending DATA packets, FRAGMENTing</span>
827 <a name="l00805"></a>00805 <span class="comment">// as required until finished, then send DONE. Both sides behave</span>
828 <a name="l00806"></a>00806 <span class="comment">// this way, so different sized data can be sent in both</span>
829 <a name="l00807"></a>00807 <span class="comment">// directions</span>
830 <a name="l00808"></a>00808 <span class="comment">//</span>
831 <a name="l00809"></a>00809 <span class="comment">// the fragmented piece only has a the param header, and then continues</span>
832 <a name="l00810"></a>00810 <span class="comment">// right on with the data</span>
833 <a name="l00811"></a>00811
834 <a name="l00812"></a>00812
835 <a name="l00813"></a>00813
836 <a name="l00814"></a>00814 <span class="comment">// checks packet size and throws BError if not right</span>
837 <a name="l00815"></a>00815 <span class="keywordtype">void</span> CheckSize(<span class="keyword">const</span> Barry::Data &amp;packet, <span class="keywordtype">size_t</span> requiredsize);
838 <a name="l00816"></a>00816 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetSize(<span class="keyword">const</span> Barry::Data &amp;packet);
839 <a name="l00817"></a>00817
840 <a name="l00818"></a>00818 }} <span class="comment">// namespace Barry::Protocol</span>
841 <a name="l00819"></a>00819
842 <a name="l00820"></a>00820 <span class="preprocessor">#endif</span>
843 <a name="l00821"></a>00821 <span class="preprocessor"></span>
844 </pre></div></div>
845 <hr size="1"><address style="text-align: right;"><small>Generated on Sat Aug 29 00:01:53 2009 for Barry by&nbsp;
846 <a href="http://www.doxygen.org/index.html">
847 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
848 </body>
849 </html>
Interface software for the Blackberry handheld