/*
 	File:		Keyboards.h
 
 	Contains:	Keyboard API.
 
 	Version:	Technology:	Keyboard 1.0
 				Release:	QuickTime 3.0
 
 	Copyright:	© 1997-1998 by Apple Computer, Inc., all rights reserved
 
 	Bugs?:		Please include the the file and version information (from above) with
 				the problem description.  Developers belonging to one of the Apple
 				developer programs can submit bug reports to:
 
 					devsupport@apple.com
 
*/
#ifndef __KEYBOARDS__
#define __KEYBOARDS__

#ifndef __MACTYPES__
#include <MacTypes.h>
#endif



#if PRAGMA_ONCE
#pragma once
#endif

#ifdef __cplusplus
extern "C" {
#endif

#if PRAGMA_IMPORT
#pragma import on
#endif

#if PRAGMA_STRUCT_ALIGN
	#pragma options align=mac68k
#elif PRAGMA_STRUCT_PACKPUSH
	#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
	#pragma pack(2)
#endif

/*ΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡ*/
/* Keyboard API constants															*/
/*ΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡ*/
/* Keyboard API Trap Number. Should be moved to Traps.i */

enum {
	_KeyboardDispatch			= 0xAA7A
};

/* Gestalt selector and values for the Keyboard API */

enum {
	gestaltKeyboardsAttr		= FOUR_CHAR_CODE('kbds'),
	gestaltKBPS2Keyboards		= 1,
	gestaltKBPS2SetIDToAny		= 2,
	gestaltKBPS2SetTranslationTable = 4
};

/* Keyboard API Error Codes */
/*
   I stole the range blow from the empty space in the Allocation project but should
   be updated to the officially registered range.
*/

enum {
	errKBPS2KeyboardNotAvailable = -30850,
	errKBIlligalParameters		= -30851,
	errKBFailSettingID			= -30852,
	errKBFailSettingTranslationTable = -30853,
	errKBFailWritePreference	= -30854
};


/* Keyboard HW Layout Types */

enum {
	kKeyboardJIS				= FOUR_CHAR_CODE('JIS '),
	kKeyboardANSI				= FOUR_CHAR_CODE('ANSI'),
	kKeyboardISO				= FOUR_CHAR_CODE('ISO '),
	kKeyboardUnknown			= kUnknownType
};


/*ΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡ*/
/* Keyboard API types																*/
/*ΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡ*/



/*ΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡ*/
/* Keyboard API routines															*/
/*ΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡΡ*/

EXTERN_API( OSErr )
KBInitialize					(void)														THREEWORDINLINE(0x303C, 0x0000, 0xAA7A);

EXTERN_API( OSErr )
KBSetupPS2Keyboard				(short 					deviceID,
								 char *					alternativeTable)					THREEWORDINLINE(0x303C, 0x0001, 0xAA7A);

EXTERN_API( OSErr )
KBGetPS2KeyboardID				(short *				deviceID)							THREEWORDINLINE(0x303C, 0x0002, 0xAA7A);

EXTERN_API( Boolean )
KBIsPS2KeyboardConnected		(void)														THREEWORDINLINE(0x303C, 0x0003, 0xAA7A);

EXTERN_API( Boolean )
KBIsPS2KeyboardEnabled			(void)														THREEWORDINLINE(0x303C, 0x0004, 0xAA7A);

EXTERN_API( long )
KBGetPS2KeyboardAttributes		(void)														THREEWORDINLINE(0x303C, 0x0005, 0xAA7A);

EXTERN_API( OSErr )
KBSetKCAPForPS2Keyboard			(Handle 				kcapHandle)							THREEWORDINLINE(0x303C, 0x0006, 0xAA7A);

EXTERN_API( OSType )
KBGetLayoutType					(short 					deviceID)							THREEWORDINLINE(0x303C, 0x0007, 0xAA7A);

EXTERN_API( OSErr )
KBSetupPS2KeyboardFromLayoutType (OSType 				layoutType)							THREEWORDINLINE(0x303C, 0x0008, 0xAA7A);

EXTERN_API( OSErr )
KBGetPS2KeyboardLayoutType		(OSType *				layoutType)							THREEWORDINLINE(0x303C, 0x0009, 0xAA7A);



#if PRAGMA_STRUCT_ALIGN
	#pragma options align=reset
#elif PRAGMA_STRUCT_PACKPUSH
	#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
	#pragma pack()
#endif

#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif

#ifdef __cplusplus
}
#endif

#endif /* __KEYBOARDS__ */

