HIDCountDescriptorItems.c   [plain text]

/*
 * @APPLE_LICENSE_HEADER_START@
 * 
 * Copyright (c) 1999-2012 Apple Computer, Inc.  All Rights Reserved.
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
	File:		HIDCountDescriptorItems.c

	Contains:	xxx put contents here xxx

	Version:	xxx put version here xxx

	Copyright:	© 1999 by Apple Computer, Inc., all rights reserved.

	File Ownership:

		DRI:				xxx put dri here xxx

		Other Contact:		xxx put other contact here xxx

		Technology:			xxx put technology here xxx

	Writers:

		(BWS)	Brent Schorsch

	Change History (most recent first):

	  <USB1>	  3/5/99	BWS		first checked in
*/

#include "HIDLib.h"

//#include <stdlib.h>

/*
 *------------------------------------------------------------------------------
 *
 * HIDCountDescriptorItems
 *
 *	 Input:
 *			  ptDescriptor			- Descriptor Pointer Structure
 *			  ptPreparsedData		- The PreParsedData Structure
 *	 Output:
 *			  ptPreparsedData		- The PreParsedData Structure
 *	 Returns:
 *			  kHIDSuccess		   - Success
 *			  kHIDNullPointerErr	  - Argument, Pointer was Null
 *
 *------------------------------------------------------------------------------
*/
OSStatus HIDCountDescriptorItems(HIDReportDescriptor *ptDescriptor, HIDPreparsedDataPtr ptPreparsedData)
{
	OSStatus iStatus;
	IOByteCount iSpaceRequired;
	HIDItem *ptItem;
	UInt8 *pMem;
	vm_size_t sz = 0;
/*
 *	Initialize Counters
*/
	int collectionCount	 = 1;
	int reportItemCount	 = 0;
	int iUsages		  = 0;
	int iUsageRanges  = 0;
	int iStrings	  = 0;
	int iStringRanges = 0;
	int iDesigs		  = 0;
	int iDesigRanges  = 0;
	int reportCount		 = 1;
	int globalsNesting = 0;
	int iMaxGlobalsNesting = 0;
	int collectionNesting = 0;
	int iMaxCollectionNesting = 0;
/*
 *	Disallow NULL Pointers
*/
	if ((ptDescriptor == NULL) || (ptPreparsedData == NULL))
		return kHIDNullPointerErr;
/*
 *	Initialize the memory allocation pointer
*/
	ptPreparsedData->rawMemPtr = NULL;
/*
 *	Initialize the Descriptor Pointer Structure
*/
	ptDescriptor->index = 0;
	ptItem = &ptDescriptor->item;
/*
 *	Count various items in the descriptor
*/
	while ((iStatus = HIDNextItem(ptDescriptor)) == kHIDSuccess)
	{
		switch (ptItem->itemType)
		{
			case kHIDTypeMain:
				switch (ptItem->tag)
				{
					case kHIDTagCollection:
						collectionCount++;
						collectionNesting++;
						if (collectionNesting > iMaxCollectionNesting)
							iMaxCollectionNesting = collectionNesting;
						break;
					case kHIDTagEndCollection:
						if (collectionNesting-- == 0)
							return kHIDInvalidPreparsedDataErr;
						break;
					case kHIDTagInput:
					case kHIDTagOutput:
					case kHIDTagFeature:
						reportItemCount++;
						break;
				}
				break;
			case kHIDTypeGlobal:
				switch (ptItem->tag)
				{
					case kHIDTagReportID:
						reportCount++;
						break;
					case kHIDTagPush:
						globalsNesting++;
						if (globalsNesting > iMaxGlobalsNesting)
							iMaxGlobalsNesting = globalsNesting;
						break;
					case kHIDTagPop:
						globalsNesting--;
						if (globalsNesting < 0)
							return kHIDInvalidPreparsedDataErr;
						break;
				}
				break;
			case kHIDTypeLocal:
				switch (ptItem->tag)
				{
					case kHIDTagUsage:
						iUsages++;
						break;
					case kHIDTagUsageMinimum:
					case kHIDTagUsageMaximum:
						iUsageRanges++;
						break;
					case kHIDTagStringIndex:
						iStrings++;
						break;
					case kHIDTagStringMinimum:
					case kHIDTagStringMaximum:
						iStringRanges++;
						break;
					case kHIDTagDesignatorIndex:
						iDesigs++;
						break;
					case kHIDTagDesignatorMinimum:
					case kHIDTagDesignatorMaximum:
						iDesigRanges++;
						break;
				}
		}
	}
/*
 *	Disallow malformed descriptors
*/
	if ((collectionNesting != 0)
	 || (collectionCount == 1)
	 || (reportItemCount == 0)
	 || ((iUsageRanges & 1) == 1)
	 || ((iStringRanges & 1) == 1)
	 || ((iDesigRanges & 1) == 1))
		return kHIDInvalidPreparsedDataErr;
/*
 *	Summarize the Indices and Ranges
*/
	iUsages += (iUsageRanges/2);
	iStrings += (iStringRanges/2);
	iDesigs += (iDesigRanges/2);
/*
 *	Calculate the space needed for the structures
*/
	if (os_mul_overflow(sizeof(HIDCollection), collectionCount, &sz)) return kHIDInvalidPreparsedDataErr;
	iSpaceRequired = (sizeof(HIDCollection) * collectionCount);

	if (os_mul_overflow(sizeof(HIDReportItem), reportItemCount, &sz)) return kHIDInvalidPreparsedDataErr;
	if (os_add_overflow(iSpaceRequired, (sizeof(HIDReportItem) * reportItemCount), &sz)) return kHIDInvalidPreparsedDataErr;
	iSpaceRequired += (sizeof(HIDReportItem) * reportItemCount);

	if (os_mul_overflow(sizeof(HIDReportSizes), reportCount, &sz)) return kHIDInvalidPreparsedDataErr;
	if (os_add_overflow(iSpaceRequired, (sizeof(HIDReportSizes) * reportCount), &sz)) return kHIDInvalidPreparsedDataErr;
	iSpaceRequired += (sizeof(HIDReportSizes) * reportCount);

	if (os_mul_overflow(sizeof(HIDP_UsageItem), iUsages, &sz)) return kHIDInvalidPreparsedDataErr;
	if (os_add_overflow(iSpaceRequired, (sizeof(HIDP_UsageItem) * iUsages), &sz)) return kHIDInvalidPreparsedDataErr;
	iSpaceRequired += (sizeof(HIDP_UsageItem) * iUsages);

	if (os_mul_overflow(sizeof(HIDStringItem), iStrings, &sz)) return kHIDInvalidPreparsedDataErr;
	if (os_add_overflow(iSpaceRequired, (sizeof(HIDStringItem) * iStrings), &sz)) return kHIDInvalidPreparsedDataErr;
	iSpaceRequired += (sizeof(HIDStringItem) * iStrings);

	if (os_mul_overflow(sizeof(HIDDesignatorItem), iDesigs, &sz)) return kHIDInvalidPreparsedDataErr;
	if (os_add_overflow(iSpaceRequired, (sizeof(HIDDesignatorItem) * iDesigs), &sz)) return kHIDInvalidPreparsedDataErr;
	iSpaceRequired += (sizeof(HIDDesignatorItem) * iDesigs);

	if (os_mul_overflow(sizeof(int), iMaxCollectionNesting, &sz)) return kHIDInvalidPreparsedDataErr;
	if (os_add_overflow(iSpaceRequired, (sizeof(int) * iMaxCollectionNesting), &sz)) return kHIDInvalidPreparsedDataErr;
	iSpaceRequired += (sizeof(int) * iMaxCollectionNesting);

	if (os_mul_overflow(sizeof(HIDGlobalItems), iMaxGlobalsNesting, &sz)) return kHIDInvalidPreparsedDataErr;
	if (os_add_overflow(iSpaceRequired, (sizeof(HIDGlobalItems) * iMaxGlobalsNesting), &sz)) return kHIDInvalidPreparsedDataErr;
	iSpaceRequired += (sizeof(HIDGlobalItems) * iMaxGlobalsNesting);

	pMem = PoolAllocateResident(iSpaceRequired, kShouldClearMem);
	
	if (pMem == NULL)
		return kHIDNotEnoughMemoryErr;
	ptPreparsedData->rawMemPtr = pMem;
	ptPreparsedData->numBytesAllocated = iSpaceRequired;
/*
 *	Allocate space to the various structures
*/
	ptPreparsedData->collections = (HIDCollection *) pMem;
	ptPreparsedData->collectionCount = 0;
	pMem += (sizeof(HIDCollection) * collectionCount);
	ptPreparsedData->reportItems = (HIDReportItem *) pMem;
	ptPreparsedData->reportItemCount = 0;
	pMem += (sizeof(HIDReportItem) * reportItemCount);
	ptPreparsedData->reports = (HIDReportSizes *) pMem;
	ptPreparsedData->reportCount = 0;
	pMem += (sizeof(HIDReportSizes) * reportCount);
	ptPreparsedData->usageItems = (HIDP_UsageItem *) pMem;
	ptPreparsedData->usageItemCount = 0;
	pMem += (sizeof(HIDP_UsageItem) * iUsages);
	ptPreparsedData->stringItems = (HIDStringItem *) pMem;
	ptPreparsedData->stringItemCount = 0;
	pMem += (sizeof(HIDStringItem) * iStrings);
	ptPreparsedData->desigItems = (HIDDesignatorItem *) pMem;
	ptPreparsedData->desigItemCount = 0;
	pMem += (sizeof(HIDDesignatorItem) * iDesigs);
	ptDescriptor->collectionStack = (SInt32 *) pMem;
	ptDescriptor->collectionNesting = 0;
	pMem += (sizeof(SInt32) * iMaxCollectionNesting);
	ptDescriptor->globalsStack = (HIDGlobalItems *) pMem;
	ptDescriptor->globalsNesting = 0;
	if (iStatus == kHIDEndOfDescriptorErr)
		return kHIDSuccess;
	return iStatus;
}