-
Notifications
You must be signed in to change notification settings - Fork 3
/
listing6.html
executable file
·424 lines (362 loc) · 20.8 KB
/
listing6.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<!-- BEGIN META TAG INFO -->
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="home" href="http://developer.apple.com/">
<link rel="find" href="http://developer.apple.com/search/">
<link rel="stylesheet" type="text/css" href="../../documentation/css/adcstyle.css" title="fonts">
<script language="JavaScript" src="../../documentation/js/adc.js" type="text/javascript"></script>
<!-- END META TAG INFO -->
<!-- BEGIN TITLE -->
<title>SimpleUserClient - /SimpleUserClientInterface.c</title>
<!-- END TITLE -->
<script language="JavaScript">
function JumpToNewPage() {
window.location=document.scpopupmenu.gotop.value;
return true;
}
</script>
</head>
<!-- BEGIN BODY OPEN -->
<body>
<!--END BODY OPEN -->
<!-- START CENTER OPEN -->
<center>
<!-- END CENTER OPEN -->
<!-- BEGIN LOGO AND SEARCH -->
<!--#include virtual="/includes/adcnavbar"-->
<!-- END LOGO AND SEARCH -->
<!-- START BREADCRUMB -->
<div id="breadcrumb">
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td scope="row"><img width="340" height="10" src="images/1dot.gif" alt=""></td>
<td><img width="340" height="10" src="images/1dot.gif" alt=""></td>
</tr>
<tr valign="middle">
<td align="left" colspan="2">
<a href="http://developer.apple.com/">ADC Home</a> > <a href="../../referencelibrary/index.html#//apple_ref/doc/uid/TP30000943" target="_top">Reference Library</a> > <a href="../index.html#//apple_ref/doc/uid/TP30000925" target="_top">Sample Code</a> > <a href="../Darwin/index.html#//apple_ref/doc/uid/TP30000925-TP30000422" target="_top">Darwin</a> > <a href="../Darwin/idxHardwareDrivers-date.html#//apple_ref/doc/uid/TP30000925-TP30000422-TP40003590">Hardware & Drivers</a> > <A HREF="javascript:location.replace('index.html');">SimpleUserClient</A> >
</td>
</tr>
<tr>
<td colspan="2" scope="row"><img width="680" height="35" src="images/1dot.gif" alt=""></td>
</tr>
</table>
</div>
<!-- END BREADCRUMB -->
<!-- START MAIN CONTENT -->
<!-- START TITLE GRAPHIC AND INTRO-->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td><h1><div id="pagehead">SimpleUserClient</div></h1></td>
</tr>
</table>
<!-- END TITLE GRAPHIC AND INTRO -->
<!-- START WIDE COLUMN -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td id="scdetails">
<h2>/SimpleUserClientInterface.c</h2>
<form name="scpopupmenu" onSubmit="return false;" method=post>
<p><strong>View Source Code:</strong>
<select name="gotop" onChange="JumpToNewPage();" style="width:340px"><option selected value="ingnore">Select File</option>
<option value="listing1.html">/Read Me.txt</option>
<option value="listing2.html">/SimpleDriver.cpp</option>
<option value="listing3.html">/SimpleDriver.h</option>
<option value="listing4.html">/SimpleUserClient.cpp</option>
<option value="listing5.html">/SimpleUserClient.h</option>
<option value="listing6.html">/SimpleUserClientInterface.c</option>
<option value="listing7.html">/SimpleUserClientInterface.h</option>
<option value="listing8.html">/SimpleUserClientTool.c</option>
<option value="listing9.html">/User Client Info.txt</option>
<option value="listing10.html">/UserKernelShared.h</option></select>
</p>
</form>
<p><strong><a href="SimpleUserClient.zip">Download Sample</a></strong> (“SimpleUserClient.zip”, 182.2K)<BR>
<strong><a href="SimpleUserClient.dmg">Download Sample</a></strong> (“SimpleUserClient.dmg”, 197.6K)</p>
<!--
<p><strong><a href="#">Download Sample</a></strong> (“filename.sit”, 500K)</p>
-->
</td>
</tr>
<tr>
<td scope="row"><img width="680" height="10" src="images/1dot.gif" alt=""><br>
<img height="1" width="680" src="images/1dot_919699.gif" alt=""><br>
<img width="680" height="20" src="images/1dot.gif" alt=""></td>
</tr>
<tr>
<td scope="row">
<!--googleon: index -->
<pre class="sourcecodebox">/*
File: SimpleUserClientInterface.c
Description: Implements an abstraction layer between client applications and the user client.
Copyright: Copyright © 2007-2008 Apple Inc. All rights reserved.
Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Computer, Inc.
("Apple") in consideration of your agreement to the following terms, and your
use, installation, modification or redistribution of this Apple software
constitutes acceptance of these terms. If you do not agree with these terms,
please do not use, install, modify or redistribute this Apple software.
In consideration of your agreement to abide by the following terms, and subject
to these terms, Apple grants you a personal, non-exclusive license, under Apple’s
copyrights in this original Apple software (the "Apple Software"), to use,
reproduce, modify and redistribute the Apple Software, with or without
modifications, in source and/or binary forms; provided that if you redistribute
the Apple Software in its entirety and without modifications, you must retain
this notice and the following text and disclaimers in all such redistributions of
the Apple Software. Neither the name, trademarks, service marks or logos of
Apple Computer, Inc. may be used to endorse or promote products derived from the
Apple Software without specific prior written permission from Apple. Except as
expressly stated in this notice, no other rights or licenses, express or implied,
are granted by Apple herein, including but not limited to any patent rights that
may be infringed by your derivative works or by other works in which the Apple
Software may be incorporated.
The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO
WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
COMBINATION WITH YOUR PRODUCTS.
IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION
OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT
(INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Change History (most recent first):
2.0 08/13/2008 Add Leopard user client API for supporting 64-bit user processes.
Now requires Xcode 3.0 or later to build.
1.1 05/22/2007 Split out user client interface functions from main test tool.
*/
#include <AvailabilityMacros.h>
#include <IOKit/IOKitLib.h>
#include "SimpleUserClientInterface.h"
kern_return_t MyOpenUserClient(io_connect_t connect)
{
// This calls the openUserClient method in SimpleUserClient inside the kernel. Though not mandatory, it's good
// practice to use open and close semantics in your driver to prevent multiple user space applications from
// using your driver at the same time.
kern_return_t kernResult;
#if !defined(__LP64__)
// Check if Mac OS X 10.5 API is available...
if (IOConnectCallScalarMethod != NULL) {
// ...and use it if it is.
#endif
kernResult = IOConnectCallScalarMethod(connect, kMyUserClientOpen, NULL, 0, NULL, NULL);
#if !defined(__LP64__)
}
else {
// Otherwise fall back to older API.
kernResult = IOConnectMethodScalarIScalarO(connect, kMyUserClientOpen, 0, 0);
}
#endif
return kernResult;
}
kern_return_t MyCloseUserClient(io_connect_t connect)
{
// This calls the closeUserClient method in SimpleUserClient inside the kernel, which in turn closes
// the driver.
kern_return_t kernResult;
#if !defined(__LP64__)
// Check if Mac OS X 10.5 API is available...
if (IOConnectCallScalarMethod != NULL) {
// ...and use it if it is.
#endif
kernResult = IOConnectCallScalarMethod(connect, kMyUserClientClose, NULL, 0, NULL, NULL);
#if !defined(__LP64__)
}
else {
// Otherwise fall back to older API.
kernResult = IOConnectMethodScalarIScalarO(connect, kMyUserClientClose, 0, 0);
}
#endif
return kernResult;
}
kern_return_t MyScalarIStructureI(io_connect_t connect, const uint32_t scalarI,
const size_t structISize, const MySampleStruct* structI)
{
// This calls the function ScalarIStructI in SimpleUserClient inside the kernel.
kern_return_t kernResult;
#if !defined(__LP64__)
// Check if Mac OS X 10.5 API is available...
if (IOConnectCallMethod != NULL) {
// ...and use it if it is.
#endif
uint64_t scalarI_64 = scalarI;
kernResult = IOConnectCallMethod(connect, // an io_connect_t returned from IOServiceOpen().
kMyScalarIStructIMethod, // selector of the function to be called via the user client.
&scalarI_64, // array of scalar (64-bit) input values.
1, // the number of scalar input values.
structI, // a pointer to the struct input parameter.
structISize, // the size of the input structure parameter.
NULL, // array of scalar (64-bit) output values.
NULL, // pointer to the number of scalar output values.
NULL, // pointer to the struct output parameter.
NULL // pointer to the size of the output structure parameter.
);
#if !defined(__LP64__)
}
else {
// Otherwise fall back to older API.
kernResult =
IOConnectMethodScalarIStructureI(connect, // an io_connect_t returned from IOServiceOpen().
kMyScalarIStructIMethod, // Index to the function to be called via the user client.
1, // the number of scalar (32-bit) input values.
structISize, // the size of the input structure parameter.
scalarI, // a scalar input parameter.
structI // pointer to the struct input parameter.
);
}
#endif
return kernResult;
}
kern_return_t MyScalarIStructureO(io_connect_t connect, const uint32_t scalarI_1, const uint32_t scalarI_2,
size_t* structOSize, MySampleStruct* structO)
{
// This calls the function ScalarIStructureO in SimpleUserClient inside the kernel.
kern_return_t kernResult;
#if !defined(__LP64__)
// Check if Mac OS X 10.5 API is available...
if (IOConnectCallMethod != NULL) {
// ...and use it if it is.
#endif
uint64_t scalarI_64[2];
scalarI_64[0] = scalarI_1;
scalarI_64[1] = scalarI_2;
kernResult = IOConnectCallMethod(connect, // an io_connect_t returned from IOServiceOpen().
kMyScalarIStructOMethod, // selector of the function to be called via the user client.
scalarI_64, // array of scalar (64-bit) input values.
2, // the number of scalar input values.
NULL, // a pointer to the struct input parameter.
0, // the size of the input structure parameter.
NULL, // array of scalar (64-bit) output values.
NULL, // pointer to the number of scalar output values.
structO, // pointer to the struct output parameter.
structOSize // pointer to the size of the output structure parameter.
);
#if !defined(__LP64__)
}
else {
// Otherwise fall back to older API.
kernResult =
IOConnectMethodScalarIStructureO(connect, // an io_connect_t returned from IOServiceOpen().
kMyScalarIStructOMethod, // an index to the function to be called via the user client.
2, // the number of scalar input values.
structOSize, // the size of the struct output parameter.
scalarI_1, // a scalar input parameter.
scalarI_2, // another scalar input parameter.
structO // a pointer to a struct output parameter.
);
}
#endif
return kernResult;
}
kern_return_t MyScalarIScalarO(io_connect_t connect, const uint32_t scalarI_1, const uint32_t scalarI_2, uint32_t* scalarO)
{
// This calls the function ScalarIScalarO in SimpleUserClient inside the kernel.
kern_return_t kernResult;
#if !defined(__LP64__)
// Check if Mac OS X 10.5 API is available...
if (IOConnectCallScalarMethod != NULL) {
// ...and use it if it is.
#endif
uint64_t scalarI_64[2];
uint64_t scalarO_64;
uint32_t outputCount = 1;
scalarI_64[0] = scalarI_1;
scalarI_64[1] = scalarI_2;
kernResult = IOConnectCallScalarMethod(connect, // an io_connect_t returned from IOServiceOpen().
kMyScalarIScalarOMethod, // selector of the function to be called via the user client.
scalarI_64, // array of scalar (64-bit) input values.
2, // the number of scalar input values.
&scalarO_64, // array of scalar (64-bit) output values.
&outputCount // pointer to the number of scalar output values.
);
*scalarO = (uint32_t) scalarO_64;
#if !defined(__LP64__)
}
else {
// Otherwise fall back to older API.
kernResult =
IOConnectMethodScalarIScalarO(connect, // an io_connect_t returned from IOServiceOpen().
kMyScalarIScalarOMethod, // an index to the function to be called via the user client.
2, // the number of scalar input values.
1, // the number of scalar output values.
scalarI_1, // a scalar input parameter.
scalarI_2, // another scalar input parameter.
scalarO // a scalar output parameter.
);
}
#endif
return kernResult;
}
kern_return_t MyStructureIStructureO(io_connect_t connect, const size_t structISize, const MySampleStruct* structI,
size_t* structOSize, MySampleStruct* structO)
{
// This calls the function StructureIStructureO in SimpleUserClient inside the kernel.
kern_return_t kernResult;
#if !defined(__LP64__)
// Check if Mac OS X 10.5 API is available...
if (IOConnectCallStructMethod != NULL) {
// ...and use it if it is.
#endif
kernResult = IOConnectCallStructMethod(connect, // an io_connect_t returned from IOServiceOpen().
kMyStructIStructOMethod, // selector of the function to be called via the user client.
structI, // pointer to the input struct parameter.
structISize, // the size of the input structure parameter.
structO, // pointer to the output struct parameter.
structOSize // pointer to the size of the output structure parameter.
);
#if !defined(__LP64__)
}
else {
// Otherwise fall back to older API.
kernResult =
IOConnectMethodStructureIStructureO(connect, // an io_connect_t returned from IOServiceOpen().
kMyStructIStructOMethod, // an index to the function to be called via the user client.
structISize, // the size of the input struct paramter.
structOSize, // a pointer to the size of the output struct paramter.
(MySampleStruct*) structI, // a pointer to the input struct parameter.
structO // a pointer to the output struct parameter.
);
}
#endif
return kernResult;
}
</pre>
<!--googleoff: index -->
</td>
</tr>
</table>
<!-- END WIDE COLUMN -->
<!-- END MAIN CONTENT -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td><div style="width: 100%; height: 1px; background-color: #919699; margin-top: 5px; margin-bottom: 15px"></div></td>
</tr>
<tr>
<td align="center"><br/>
<table border="0" cellpadding="0" cellspacing="0" class="graybox">
<tr>
<th>Did this document help you?</th>
</tr>
<tr>
<td>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=1&url=/samplecode/SimpleUserClient/listing6.html%3Fid%3DDTS10000450-3.0&media=dvd" target=_new>Yes</a>: Tell us what works for you.</div>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=2&url=/samplecode/SimpleUserClient/listing6.html%3Fid%3DDTS10000450-3.0&media=dvd" target=_new>It’s good, but:</a> Report typos, inaccuracies, and so forth.</div>
<div><a href="http://developer.apple.com/feedback/?v=3&url=/samplecode/SimpleUserClient/listing6.html%3Fid%3DDTS10000450-3.0&media=dvd" target=_new>It wasn’t helpful</a>: Tell us what would have helped.</div>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- START BOTTOM APPLE NAVIGATION -->
<!--#include virtual="/includes/footer"-->
<!-- END BOTTOM APPLE NAVIGATION -->
<!-- START CENTER CLOSE -->
</center>
<!-- END CENTER CLOSE -->
</body>
</html>