home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1998 November: Tool Chest / Dev.CD Nov 98 TC.toast / What's New? / Development Kits / USBDDK_v1.0.1_updated / Examples / USBTabletModule / USBTabletModuleHeader.c < prev    next >
Encoding:
C/C++ Source or Header  |  1998-09-29  |  5.9 KB  |  202 lines  |  [TEXT/MPS ]
  1. /*
  2.     File:        USBTabletModuleHeader.c
  3.  
  4.     Contains:    USBTabletModule Header file
  5.  
  6.     Version:    xxx put version here xxx
  7.  
  8.     Copyright:    © 1997-1998 by Apple Computer, Inc., all rights reserved.
  9.  
  10. */
  11.  
  12. #include <Types.h>
  13. #include <Devices.h>
  14. #include <DriverServices.h>
  15. #include <USB.h>
  16.  
  17.  
  18. #include "USBTabletModule.h"
  19. #include "USBTabletModuleVersion.h"
  20.  
  21. extern    usbTabletPBStruct myTabletPB;
  22.  
  23. //------------------------------------------------------
  24. //
  25. //    This is the driver description structure that the expert looks for first.
  26. //  If it's here, the information within is used to match the driver
  27. //  to the device whose descriptor was passed to the expert.
  28. //    Information in this block is also used by the expert when an
  29. //  entry is created in the Name Registry.
  30. //
  31. //------------------------------------------------------
  32. USBDriverDescription    TheUSBDriverDescription = 
  33. {
  34.     // Signature info
  35.     kTheUSBDriverDescriptionSignature,
  36.     kInitialUSBDriverDescriptor,
  37.     
  38.     // Device Info
  39.     0x056a,                                    // vendor = not device specific
  40.     0,                                        // product = not device specific
  41.     0,                                        // version of product = not device specific
  42.     kUSBMouseInterfaceProtocol,                // protocol = not device specific
  43.     
  44.     // Interface Info    (* I don't think this would always be required...*)                
  45.     0,                                        // Configuration Value
  46.     0,                                        // Interface Number
  47.     kUSBHIDInterfaceClass,                    // Interface Class
  48.     kUSBBootInterfaceSubClass,                 // Interface SubClass
  49.     kUSBMouseInterfaceProtocol,                // Interface Protocol
  50.         
  51.     
  52.     // Driver Info
  53.     "\pUSBHIDTabletModule",                        // Driver name for Name Registry
  54.     kUSBHIDInterfaceClass,                    // Device Class  (from USBDeviceDefines.h)
  55.     kUSBBootInterfaceSubClass,                // Device Subclass 
  56.     kTabletHexMajorVers, 
  57.     kTabletHexMinorVers, 
  58.     kTabletCurrentRelease, 
  59.     kTabletReleaseStage,                        // version of driver  
  60.     
  61.     // Driver Loading Info
  62.     kUSBProtocolMustMatch+kUSBDoNotMatchInterface+kUSBDoNotMatchGenericDevice                    // Flags (currently undefined)
  63. };
  64.  
  65. USBClassDriverPluginDispatchTable TheClassDriverPluginDispatchTable =
  66. {
  67.     kClassDriverPluginVersion,                // Version of this structure
  68.     TabletDriverValidateHW,                    // Hardware Validation Procedure
  69.     TabletDeviceInitialize,                    // Initialization Procedure
  70.     TabletInterfaceInitialize,                // Interface Initialization Procedure
  71.     TabletDriverFinalize,                    // Finalization Procedure
  72.     TabletDriverNotifyProc,                    // Driver Notification Procedure
  73. };
  74.     
  75.  
  76. // Hardware Validation
  77. // Called upon load by Expert
  78. OSStatus TabletDriverValidateHW(USBDeviceRef device, USBDeviceDescriptor *desc)
  79. {
  80. #pragma unused (device)
  81. #pragma unused (desc)
  82.  
  83.     return (OSStatus)kUSBNoErr;
  84. }
  85.  
  86.  
  87. // Initialization function
  88. // Called upon load by Expert
  89. OSStatus     TabletDeviceInitialize (USBDeviceRef device, USBDeviceDescriptorPtr pDesc,  UInt32 busPowerAvailable)
  90. {
  91. #pragma unused (busPowerAvailable)
  92.  
  93.     //DebugStr("\pIn Tablet Driver");
  94.     // until we get going, it's okay to accept a call to finalize
  95.     DeviceInitialize(device, pDesc, busPowerAvailable);
  96.     return (OSStatus)kUSBNoErr;
  97. }
  98.  
  99.  
  100. // Interface Initialization Initialization function
  101. // Called upon load by Expert
  102. OSStatus     TabletInterfaceInitialize (UInt32 interfacenum, USBInterfaceDescriptorPtr pInterface, USBDeviceDescriptorPtr pDesc, USBDeviceRef device)
  103. {
  104. #pragma unused (interfacenum)
  105. #pragma unused (pInterface)
  106. #pragma unused (pDesc)
  107. #pragma unused (device)
  108.  
  109.     return (OSStatus)noErr;
  110. }
  111.  
  112. // Termination function
  113. // Called by Expert when driver is being shut down
  114. OSStatus TabletDriverFinalize(USBDeviceRef theDeviceRef, USBDeviceDescriptorPtr pDesc)
  115. {
  116. #pragma unused (pDesc)
  117. OSStatus myErr;
  118. //USBHIDData        theTabletData;
  119.  
  120.     USBExpertStatus(theDeviceRef, "\pUSBHIDTabletModule: Finalize", theDeviceRef);
  121.     
  122.     /*
  123.     if (myTabletPB.pSHIMInterruptRoutine)            
  124.     {                                                
  125.         USBExpertStatus(theDeviceRef, "\pUSBHIDTabletModule: Release Tablet buttons", theDeviceRef);
  126.         theTabletData.Tablet.buttons = 0;
  127.         theTabletData.Tablet.XDelta = 1;
  128.         theTabletData.Tablet.YDelta = 1;
  129.         (*myTabletPB.pSHIMInterruptRoutine)(myTabletPB.interruptRefcon, (void *)&theTabletData);
  130.     }
  131.     */
  132.     
  133.     if (myTabletPB.pCursorDeviceInfo != 0)                
  134.     {
  135.         USBExpertStatus(theDeviceRef, "\pUSBHIDTabletModule: Remove CDM device", theDeviceRef);
  136.         CursorDeviceDisposeDevice(myTabletPB.pCursorDeviceInfo);
  137.         myTabletPB.pCursorDeviceInfo = 0;
  138.     }
  139.     
  140.     if (myTabletPB.pipeRef)
  141.     {
  142.         USBExpertStatus(theDeviceRef, "\pUSBHIDTabletModule: Aborting interrupt pipe", theDeviceRef);
  143.         USBAbortPipeByReference(myTabletPB.pipeRef);
  144.     }
  145.     
  146.     myTabletPB.pb.usbReference = theDeviceRef;
  147.     myTabletPB.pb.pbVersion = kUSBCurrentPBVersion;
  148.     myTabletPB.pb.usbFlags = 0;
  149.     myTabletPB.pb.usbRefcon = 0;             
  150.     myTabletPB.pb.usbCompletion = (USBCompletion)-1;
  151.     
  152.     myErr = USBDeallocMem(&myTabletPB.pb);
  153.     
  154.     return (OSStatus)noErr;
  155. }
  156.  
  157. OSStatus    TabletDriverNotifyProc(UInt32     notification, void *pointer)
  158. {
  159. #pragma unused (pointer)
  160. #pragma unused (notification)
  161.     return(kUSBNoErr);
  162. }
  163.  
  164. void DeviceInitialize(USBDeviceRef device, USBDeviceDescriptorPtr pDeviceDescriptor, UInt32 busPowerAvailable)
  165. {
  166. #pragma unused (pDeviceDescriptor)
  167. static Boolean beenThereDoneThat = false;
  168.  
  169.     DebugStr("\pIn Tablet Driver");
  170.     if(beenThereDoneThat)
  171.     {
  172.         USBExpertFatalError(device, kUSBInternalErr, "\pTablet driver is not reentrant!", 0);
  173.         return;
  174.     }
  175.     beenThereDoneThat = true;
  176.     
  177.     InitParamBlock(device, &myTabletPB.pb);
  178.     
  179.     myTabletPB.deviceRef = device;    
  180.     myTabletPB.pSHIMInterruptRoutine = nil;
  181.     myTabletPB.pSavedInterruptRoutine = nil;
  182.  
  183.     myTabletPB.busPowerAvailable = busPowerAvailable;                            
  184.     myTabletPB.transDepth = 0;                            
  185.     myTabletPB.retryCount = kTabletRetryCount;
  186.     
  187.     myTabletPB.deviceRef = device;        
  188.     myTabletPB.interfaceRef = nil;        
  189.     myTabletPB.pipeRef = nil;        
  190.     
  191.     myTabletPB.pb.usbRefcon = kFindInterface;            
  192.     myTabletPB.pb.usbReference = device;
  193.     myTabletPB.pb.pbLength = sizeof(usbTabletPBStruct);
  194.     myTabletPB.unitsPerInch = (Fixed)(400<<16);
  195.     myTabletPB.pCursorDeviceInfo = 0;                
  196.     API_ControlDevice(kHIDEnableDemoMode,0);
  197.  
  198.     InitParamBlock(device, &myTabletPB.pb);
  199.     InitiateTransactionProc(&myTabletPB.pb);
  200. }
  201.  
  202.