iokit/Families/IOHIDSystem/IOHIDDescriptorParser/HIDUsageInRange.c

   1 /*
   2  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23         File:           HIDUsageInRange.c
  24
  25         Contains:       xxx put contents here xxx
  26
  27         Version:        xxx put version here xxx
  28
  29         Copyright:      © 1999 by Apple Computer, Inc., all rights reserved.
  30
  31         File Ownership:
  32
  33                 DRI:                            xxx put dri here xxx
  34
  35                 Other Contact:          xxx put other contact here xxx
  36
  37                 Technology:                     xxx put technology here xxx
  38
  39         Writers:
  40
  41                 (BWS)   Brent Schorsch
  42
  43         Change History (most recent first):
  44
  45           <USB1>          3/5/99        BWS             first checked in
  46 */
  47
  48 #include "HIDLib.h"
  49
  50 /*
  51  *------------------------------------------------------------------------------
  52  *
  53  * HIDUsageInRange
  54  *
  55  *       Input:
  56  *                        ptUsage                               - The usage/UsageRange Item
  57  *                        usagePage                        - The usagePage of the Item - or zero
  58  *                        usage                            - The usage of the Item
  59  *       Output:
  60  *       Returns:
  61  *                        true                                  - usagePage/usage is in usage/UsageRange
  62  *                        false                                 - usagePage/usage is not in usage/UsageRange
  63  *
  64  *------------------------------------------------------------------------------
  65 */
  66 Boolean HIDUsageInRange (HIDP_UsageItem *ptUsage, HIDUsage usagePage, HIDUsage usage)
  67 {
  68 /*
  69  *      Disallow Null Pointers
  70 */
  71         if (ptUsage == NULL)
  72                 return false;
  73 /*
  74  *      Check for the proper Page, 0 means don't care
  75 */
  76         if ((usagePage != 0) && (ptUsage->usagePage != usagePage))
  77                 return false;
  78 /*
  79  *      usage = 0 means don't care
  80 */
  81         if (usage == 0)
  82                 return true;
  83 /*
  84  *      The requested usage must match or be in the range
  85 */
  86         if (ptUsage->isRange)
  87         {
  88                 if ((ptUsage->usageMinimum > usage) || (ptUsage->usageMaximum < usage))
  89                         return false;
  90         }
  91         else
  92         {
  93                 if (ptUsage->usage != usage)
  94                         return false;
  95         }
  96         return true;
  97 }