/
OldMethod.c
executable file
·339 lines (274 loc) · 13.9 KB
/
OldMethod.c
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
/*
File: OldMethod.c
Description: Part of the sample SCSIOldAndNew. This sample demonstrates how to use the SCSITask User
Client (STUC) and the (as of Mac OS X 10.2) deprecated IOSCSIUserClient APIs to find
SCSI devices and issue a simple INQUIRY command to each device.
Copyright: © Copyright 2003-2006 Apple Computer, 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):
1.1 10/10/2006 Updated to produce a universal binary. Now requires Xcode 2.2.1 or
later to build.
1.0 05/08/2003 New sample.
*/
// The "old" method exists only from Mac OS X 10.0.x through 10.2.x.
#include <AvailabilityMacros.h>
#if MAC_OS_X_VERSION_MIN_REQUIRED <= MAC_OS_X_VERSION_10_2
#include "OldMethod.h"
void CreateMatchingDictionaryForOldMethod(SInt32 peripheralDeviceType, CFMutableDictionaryRef *matchingDict)
{
SInt32 deviceTypeNumber = peripheralDeviceType;
CFNumberRef deviceTypeRef = NULL;
// Set up a matching dictionary to search the I/O Registry by class name for
// all subclasses of IOSCSIDevice.
*matchingDict = IOServiceMatching(kIOSCSIDeviceClassName);
if (*matchingDict != NULL)
{
// Add key for device type to refine the matching dictionary.
// First create a CFNumber to store in the dictionary.
deviceTypeRef = CFNumberCreate(kCFAllocatorDefault, kCFNumberIntType, &deviceTypeNumber);
CFDictionarySetValue(*matchingDict, CFSTR(kSCSIPropertyDeviceTypeID), deviceTypeRef);
}
}
boolean_t FindDevicesUsingOldMethod(SInt32 peripheralDeviceType, mach_port_t masterPort, io_iterator_t *iterator)
{
CFMutableDictionaryRef matchingDict = NULL;
boolean_t result = false;
// Set up a matching dictionary to search the I/O Registry for SCSI devices
// we are interested in.
CreateMatchingDictionaryForOldMethod(peripheralDeviceType, &matchingDict);
if (matchingDict == NULL) {
fprintf(stderr, "Couldn't create a matching dictionary.\n");
}
else {
kern_return_t kr;
// Now search I/O Registry for matching devices.
kr = IOServiceGetMatchingServices(masterPort, matchingDict, iterator);
if (*iterator && kr == kIOReturnSuccess) {
result = true;
}
}
// IOServiceGetMatchingServices consumes a reference to the
// matching dictionary, so we don't need to release the dictionary ref.
return result;
}
void PrintSCSIInquiryDataUsingOldMethod(SCSIInquiry *inquiryData, UInt32 inquiryDataSize)
{
int dataSize;
fprintf(stderr, "\n*********** INQUIRY DATA ***********\n");
fprintf(stderr, "Got inquiry results size = %ld\n", inquiryDataSize);
fprintf(stderr, " Peripheral device type = 0x%02x\n", inquiryData->devType & kSCSIDevTypeMask);
fprintf(stderr, " Removable media bit = %d\n", inquiryData->devTypeMod == kSCSIDevTypeModRemovable);
fprintf(stderr, " Version = 0x%x\n", inquiryData->version);
fprintf(stderr, " Response data format = 0x%x\n", inquiryData->format);
fprintf(stderr, " Additional length = 0x%x\n", inquiryData->length);
fprintf(stderr, " SCCS and Reserved = 0x%x\n", inquiryData->reserved5);
fprintf(stderr, " Byte 6 flags = 0x%x\n", inquiryData->reserved6);
fprintf(stderr, " Byte 7 flags = 0x%x\n", inquiryData->flags);
// The SCSI Primary Commands spec doesn't require VENDOR IDENTIFICATION, PRODUCT IDENTIFICATION,
// or PRODUCT REVISION LEVEL to be NUL-terminated, hence the precision values in the following
// fprintf format strings.
fprintf(stderr, " Vendor identification = \"%.8s\"\n", inquiryData->vendorName);
fprintf(stderr, " Product identification = \"%.16s\"\n", inquiryData->productName);
fprintf(stderr, " Product revision level = \"%.4s\"\n", inquiryData->productRevision);
fprintf(stderr, " Vendor specific = \"%.20s\"\n", inquiryData->vendorSpecific);
// Determine if there is any more data to print. To do so, substract the number of
// bytes in the structure before the moreReserved field from the passed
// value for the total size, giving the amount of data in the moreReserved field.
// If there is any more data, print the hex values for the characters.
dataSize = inquiryDataSize - ((char *) &inquiryData->moreReserved - (char *) inquiryData);
if (dataSize > 0) {
int i;
fprintf(stderr, " moreReserved(%d) = ", dataSize);
for (i = 0; i < dataSize; i++) {
if ( !(i & 0xf) ) {
fprintf(stderr, "\n");
}
fprintf(stderr, "%02x ", ((UInt8 *) inquiryData->moreReserved)[i]);
}
fprintf(stderr, "\n");
}
fprintf(stderr, "\n");
}
void GetInquiryDataUsingOldMethod(IOSCSIDeviceInterface **interface)
{
UInt8 inquiryData[255];
UInt32 inquiryDataSize = sizeof(inquiryData);
kern_return_t kr = kIOReturnSuccess;
bzero(inquiryData, sizeof(inquiryData)); // Zero data block.
// Call a function of the SCSI user client that returns cached information
// about the device.
kr = (*interface)->getInquiryData(interface, (SCSIInquiry *) inquiryData,
sizeof(inquiryData), &inquiryDataSize);
if (kr != kIOReturnSuccess) {
fprintf(stderr, "Couldn't get inquiry data for device. (0x%08x)\n", kr);
}
else {
PrintSCSIInquiryDataUsingOldMethod((SCSIInquiry *) inquiryData, inquiryDataSize);
}
}
void CreateDeviceInterfaceUsingOldMethod(io_object_t scsiDevice, IOSCSIDeviceInterface ***interface)
{
io_name_t className;
IOCFPlugInInterface **plugInInterface = NULL;
HRESULT plugInResult = S_OK;
kern_return_t kr = kIOReturnSuccess;
SInt32 score = 0;
// Get the object's class name just to display it
kr = IOObjectGetClass(scsiDevice, className);
if (kr != kIOReturnSuccess) {
fprintf(stderr, "Failed to get class name. (0x%08x)\n", kr);
}
else {
fprintf(stderr, "Found device class \"%s\" using old method.\n", className);
// Create the base interface of type IOCFPlugInInterface.
// This object will be used to create the SCSI device interface object.
kr = IOCreatePlugInInterfaceForService( scsiDevice,
kIOSCSIUserClientTypeID, kIOCFPlugInInterfaceID,
&plugInInterface, &score);
if (kr != kIOReturnSuccess) {
fprintf(stderr, "Couldn't create a plugin interface for the io_service_t. (0x%08x)\n", kr);
}
else {
// Query the base plugin interface for an instance of the specific SCSI device interface
// object.
plugInResult = (*plugInInterface)->QueryInterface(plugInInterface,
CFUUIDGetUUIDBytes(kIOSCSIDeviceInterfaceID),
(LPVOID *) interface);
if (plugInResult != S_OK) {
fprintf(stderr, "Couldn't create SCSI device interface. (%ld)\n", plugInResult);
}
// We're now finished with the instance of IOCFPlugInInterface.
IODestroyPlugInInterface(plugInInterface);
}
}
}
IOCDBCommandInterface **CreateCommandInterfaceUsingOldMethod(IOSCSIDeviceInterface **interface)
{
HRESULT plugInResult = S_OK;
IOCDBCommandInterface **cdbCmdInterface = NULL;
fprintf(stderr, "Opened device\n");
plugInResult = (*interface)->QueryInterface(interface, CFUUIDGetUUIDBytes(kIOCDBCommandInterfaceID),
(LPVOID *) &cdbCmdInterface);
if (plugInResult != S_OK) {
fprintf(stderr, "Couldn't create a CDB command. (%ld)\n", plugInResult);
}
return cdbCmdInterface;
}
void ExecuteInquiryUsingOldMethod(IOCDBCommandInterface **cdbCommandInterface)
{
UInt8 inquiryData[36 /* 255 */];
IOVirtualRange range[1];
CDBInfo cdb;
CDBResults results;
UInt32 seqNumber;
kern_return_t kr = kIOReturnSuccess;
bzero(inquiryData, sizeof(inquiryData)); // Zero data block.
range[0].address = (IOVirtualAddress) inquiryData;
range[0].length = sizeof(inquiryData);
bzero(&cdb, sizeof(cdb));
cdb.cdbLength = 6;
cdb.cdb[0] = kSCSICmdInquiry;
cdb.cdb[4] = sizeof(inquiryData);
kr = (*cdbCommandInterface)->setAndExecuteCommand(
cdbCommandInterface,
&cdb,
sizeof(inquiryData),
range,
sizeof(range) / sizeof(range[0]),
0, /* isWrite */
0, /* timeoutMS */
0, /* target */
0, /* callback */
0, /* refcon */
&seqNumber);
if (kr != kIOReturnSuccess && kr != kIOReturnUnderrun) {
fprintf(stderr, "Couldn't execute a CDB command. (0x%08x)\n", kr);
}
else {
if (kr == kIOReturnUnderrun) {
fprintf(stderr, "Command underrun.\n");
}
kr = (*cdbCommandInterface)->getResults(cdbCommandInterface, &results);
if (kr != kIOReturnSuccess && kr != kIOReturnUnderrun) {
fprintf(stderr, "Couldn't get results of a command. (0x%08x)\n", kr);
}
else {
if (kr == kIOReturnUnderrun) {
fprintf(stderr, "getResults underrun.\n");
}
PrintSCSIInquiryDataUsingOldMethod((SCSIInquiry *) inquiryData, results.bytesTransferred);
}
}
}
void TestADeviceUsingOldMethod(IOSCSIDeviceInterface **interface)
{
kern_return_t kr = kIOReturnSuccess;
IOCDBCommandInterface **cdbCommandInterface = NULL;
// Get and print cached device information.
// Could examine cached information to verify this is the device to work with.
GetInquiryDataUsingOldMethod(interface);
// Open the device, attempt to get live information for it, then close it.
kr = (*interface)->open(interface);
if (kr != kIOReturnSuccess) {
fprintf(stderr, "Error opening SCSI device. (0x%08x)\n", kr);
}
else {
// Create a CDB command interface and execute a command to query the device.
cdbCommandInterface = CreateCommandInterfaceUsingOldMethod(interface);
if (cdbCommandInterface) {
ExecuteInquiryUsingOldMethod(cdbCommandInterface);
(*cdbCommandInterface)->Release(cdbCommandInterface);
}
// Close the device we opened.
(*interface)->close(interface);
}
}
void TestDevicesUsingOldMethod(io_iterator_t iterator)
{
io_service_t scsiDevice = NULL;
IOSCSIDeviceInterface **interface = NULL;
kern_return_t kr = kIOReturnSuccess;
while ((scsiDevice = IOIteratorNext(iterator))) {
// Get each device, then print cached info, then run live query.
CreateDeviceInterfaceUsingOldMethod(scsiDevice, &interface);
kr = IOObjectRelease(scsiDevice); // Done with SCSI object from I/O Registry.
if (kr != kIOReturnSuccess) {
fprintf(stderr, "Error releasing SCSI device. (0x%08x)\n", kr);
}
if (interface != NULL) {
TestADeviceUsingOldMethod(interface);
(*interface)->Release(interface);
}
}
}
#endif