Keyboard Device - Revision history

Costel Mincea: Text replacement - "" to ""

2025-01-26T19:12:29Z

Text replacement - "<syntaxhighlight>" to "<syntaxhighlight lang="C" line>"

← Older revision		Revision as of 19:12, 26 January 2025
Line 29:		Line 29:
	The I/O request used by the keyboard device is called IOStdReq.		The I/O request used by the keyboard device is called IOStdReq.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct IOStdReq		struct IOStdReq
	{		{
Line 55:		Line 55:
	* Open the keyboard device. Call OpenDevice(), passing the I/O request.		* Open the keyboard device. Call OpenDevice(), passing the I/O request.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct MsgPort *KeyMP = IExec->AllocSysObjectTags(ASOT_PORT, TAG_END);		struct MsgPort *KeyMP = IExec->AllocSysObjectTags(ASOT_PORT, TAG_END);

Line 76:		Line 76:
	All I/O requests must be complete before CloseDevice(). If any requests are still pending, abort them with AbortIO() and remove them with WaitIO().		All I/O requests must be complete before CloseDevice(). If any requests are still pending, abort them with AbortIO() and remove them with WaitIO().

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	if (!(IExec->CheckIO(KeyIO)))		if (!(IExec->CheckIO(KeyIO)))
	{		{
Line 93:		Line 93:
	The following example will read the key matrix and display the up-down state of all of the elements in the matrix in a table. Reading the column header and then the row number as a hex number gives you the raw key code.		The following example will read the key matrix and display the up-down state of all of the elements in the matrix in a table. Reading the column header and then the row number as a hex number gives you the raw key code.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	/*		/*
	* Read_Keyboard_Matrix.c		* Read_Keyboard_Matrix.c
Line 482:		Line 482:
	Shown below is an example keyboard.device read-event program:		Shown below is an example keyboard.device read-event program:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	/*		/*
	* Keyboard_Events.c		* Keyboard_Events.c

Steven Solie: /* Reading Keyboard Events */

2015-11-04T18:16:04Z

Reading Keyboard Events

← Older revision		Revision as of 18:16, 4 November 2015
Line 472:		Line 472:
	Reading keyboard events is normally not done through direct access to the keyboard device. (Higher level devices such as the input device and console device are available for this. See [[Input Device]] for more information on the intimate linkage between the input device and the keyboard device.) This section is provided primarily to show you the component parts of a keyboard input event.		Reading keyboard events is normally not done through direct access to the keyboard device. (Higher level devices such as the input device and console device are available for this. See [[Input Device]] for more information on the intimate linkage between the input device and the keyboard device.) This section is provided primarily to show you the component parts of a keyboard input event.

	The keyboard matrix figure shown at the beginning of this ~~chapter~~ gives the code value that each key places into the ie_Code field of the input event for a key-down event. For a key-up event, a value of hexadecimal 80 is or’ed with the value shown above. Additionally, if either shift key is down, or if the key is one of those in the numeric keypad, the qualifier field of the keyboard input event will be filled in accordingly.		The keyboard matrix figure shown at the beginning of this article gives the code value that each key places into the ie_Code field of the input event for a key-down event. For a key-up event, a value of hexadecimal 80 is or’ed with the value shown above. Additionally, if either shift key is down, or if the key is one of those in the numeric keypad, the qualifier field of the keyboard input event will be filled in accordingly.

	When you ask to read events from the keyboard, the call will not be satisfied until at least one keyboard event is available to be returned. The io_Length field must contain the number of bytes available in io_Data to insert events into. Thus, you should use a multiple of the number of bytes in an InputEvent (see example below).		When you ask to read events from the keyboard, the call will not be satisfied until at least one keyboard event is available to be returned. The io_Length field must contain the number of bytes available in io_Data to insert events into. Thus, you should use a multiple of the number of bytes in an InputEvent (see example below).

Steven Solie: /* Reading Keyboard Events */

2015-11-04T18:15:52Z

Reading Keyboard Events

← Older revision		Revision as of 18:15, 4 November 2015
Line 470:		Line 470:
	== Reading Keyboard Events ==		== Reading Keyboard Events ==

	Reading keyboard events is normally not done through direct access to the keyboard device. (Higher level devices such as the input device and console device are available for this. See ~~the chapter~~ [[Input Device]], for more information on the intimate linkage between the input device and the keyboard device.) This section is provided primarily to show you the component parts of a keyboard input event.		Reading keyboard events is normally not done through direct access to the keyboard device. (Higher level devices such as the input device and console device are available for this. See [[Input Device]] for more information on the intimate linkage between the input device and the keyboard device.) This section is provided primarily to show you the component parts of a keyboard input event.

	The keyboard matrix figure shown at the beginning of this chapter gives the code value that each key places into the ie_Code field of the input event for a key-down event. For a key-up event, a value of hexadecimal 80 is or’ed with the value shown above. Additionally, if either shift key is down, or if the key is one of those in the numeric keypad, the qualifier field of the keyboard input event will be filled in accordingly.		The keyboard matrix figure shown at the beginning of this chapter gives the code value that each key places into the ie_Code field of the input event for a key-down event. For a key-up event, a value of hexadecimal 80 is or’ed with the value shown above. Additionally, if either shift key is down, or if the key is one of those in the numeric keypad, the qualifier field of the keyboard input event will be filled in accordingly.

Steven Solie at 20:09, 13 May 2013

2013-05-13T20:09:14Z

← Older revision		Revision as of 20:09, 13 May 2013
Line 154:		Line 154:
	uint8 *keyMatrix;		uint8 *keyMatrix;

	if ( KeyMP = IExec->AllocSysObjectTags ( ASOT_PORT, ~~TAG_DONE~~ ) )		if ( KeyMP = IExec->AllocSysObjectTags ( ASOT_PORT, TAG_END ) )
	{		{
	if ( KeyIO = IExec->AllocSysObjectTags ( ASOT_IOREQUEST, ASOIOR_ReplyPort, KeyMP, ASOIOR_Size, sizeof ( struct IOStdReq ), ~~TAG_DONE~~ ) )		if ( KeyIO = IExec->AllocSysObjectTags ( ASOT_IOREQUEST, ASOIOR_ReplyPort, KeyMP, ASOIOR_Size, sizeof ( struct IOStdReq ), TAG_END ) )
	{		{
	if ( ! IExec->OpenDevice ( "keyboard.device", 0, ( struct IORequest * ) KeyIO, 0 ) )		if ( ! IExec->OpenDevice ( "keyboard.device", 0, ( struct IORequest * ) KeyIO, 0 ) )
	{		{
	if ( keyMatrix = IExec->AllocVecTags ( MATRIX_SIZE, AVT_ClearWithValue, 0, ~~TAG_DONE~~ ) )		if ( keyMatrix = IExec->AllocVecTags ( MATRIX_SIZE, AVT_ClearWithValue, 0, TAG_END ) )
	{		{
	KeyIO->io_Command = KBD_READMATRIX;		KeyIO->io_Command = KBD_READMATRIX;

Steven Solie at 23:09, 4 April 2013

2013-04-04T23:09:31Z

← Older revision		Revision as of 23:09, 4 April 2013
Line 1:		Line 1:
	[[Category:Devices\|Keyboard]]{{~~WIP~~}}		[[Category:Devices\|Keyboard]]{{CodeReview}}
	== Keyboard Device ==		== Keyboard Device ==

Steven Solie: /* Reading Keyboard Events */

2013-04-04T23:08:54Z

Reading Keyboard Events

Show changes

Steven Solie: /* Ending a Reset Task */

2013-04-04T23:02:57Z

Ending a Reset Task

← Older revision		Revision as of 23:02, 4 April 2013
Line 235:		Line 235:
	This command tells the system that your reset handling code has completed. If you are the last outstanding reset handler, the system will reset after this call.		This command tells the system that your reset handling code has completed. If you are the last outstanding reset handler, the system will reset after this call.

		⚫	{{Note\|title=Can’t Stop, Got No Brakes\|text=After 10 seconds, the system will reboot, regardless of outstanding reset handlers.}}
	{\| class="wikitable"
⚫	\| ''Can’t Stop, Got No Brakes~~.''~~ After 10 seconds, the system will reboot, regardless of outstanding reset handlers.
	\|}

	Here is an example program that installs a reset handler and either waits for the reboot or for the user to close the window. If there was a reboot, the window will close and, if executed from the shell, it will display a few messages. If the user closes the window, the handler is removed and the program exits cleanly.		Here is an example program that installs a reset handler and either waits for the reboot or for the user to close the window. If there was a reboot, the window will close and, if executed from the shell, it will display a few messages. If the user closes the window, the handler is removed and the program exits cleanly.

Steven Solie: /* Adding a Reset Handler */

2013-04-04T23:02:24Z

Adding a Reset Handler

← Older revision		Revision as of 23:02, 4 April 2013
Line 223:		Line 223:
	The io_Data field of the I/O request is filled in with a pointer to the Interrupt structure and the io_Command field is set to KBD_ADDRESETHANDLER. These are the only two fields you need to initialize to add a reset handler. Any return value from the command is ignored. All keyboard reset handlers are activated if time permits. Normally, a reset handler will just signal the requisite task and return. The task then does whatever processing it needs to do and notifies the system that it is done by using the KBD_RESETHANDLERDONE command described below.		The io_Data field of the I/O request is filled in with a pointer to the Interrupt structure and the io_Command field is set to KBD_ADDRESETHANDLER. These are the only two fields you need to initialize to add a reset handler. Any return value from the command is ignored. All keyboard reset handlers are activated if time permits. Normally, a reset handler will just signal the requisite task and return. The task then does whatever processing it needs to do and notifies the system that it is done by using the KBD_RESETHANDLERDONE command described below.

		⚫	{{Note\|title=Non-interference and speed are the keys to success\|text=If you add your own handler to the chain, you ''must'' ensure that your handler allows the rest of reset processing to occur. Reset ''must'' continue to function. Also, if you don’t execute your reset code fast enough, the system will still reboot (about 10 seconds).}}
	{\| class="wikitable"
⚫	\| ''Non-interference and speed are the keys to success~~.''~~ If you add your own handler to the chain, you ''must'' ensure that your handler allows the rest of reset processing to occur. Reset ''must'' continue to function. Also, if you don’t execute your reset code fast enough, the system will still reboot (about 10 seconds).
	\|}

	=== Removing a Reset Handler ===		=== Removing a Reset Handler ===

Steven Solie: /* Reading the Keyboard Matrix */

2013-04-04T23:01:53Z

Reading the Keyboard Matrix

← Older revision		Revision as of 23:01, 4 April 2013
Line 207:		Line 207:
	In addition to the matrix data returned in io_Data, io_Actual returns the number of bytes filled in io_Data with key matrix data, i.e., the minimum of the supplied length and the internal key matrix size.		In addition to the matrix data returned in io_Data, io_Actual returns the number of bytes filled in io_Data with key matrix data, i.e., the minimum of the supplied length and the internal key matrix size.

		⚫	{{Note\|title=Value of io_Length\|text=A value of 13 in the io_Length field will be sufficient for most keyboards; extended keyboards will require a larger number.}}
	{\| class="wikitable"
⚫	\| ''Value of io_Length~~.''~~ A value of 13 in the io_Length field will be sufficient for most keyboards; extended keyboards will require a larger number. ~~However, you ''must'' always set this field to 13 for V34 and earlier versions of Kickstart.~~
	\|}

	To find the status of a particular key—for example, to find out if the F2 key is down—you find the bit that specifies the current state by dividing the key matrix value by 8. Since hex 51 = 81, this indicates that the bit is in byte number 10 of the matrix. Then take the same number (decimal 81) and use modulo 8 to determine which bit position within that byte represents the state of the key. This yields a value of 1. So, by reading bit position 1 of byte number 10, you determine the status of the function key F2.		To find the status of a particular key—for example, to find out if the F2 key is down—you find the bit that specifies the current state by dividing the key matrix value by 8. Since hex 51 = 81, this indicates that the bit is in byte number 10 of the matrix. Then take the same number (decimal 81) and use modulo 8 to determine which bit position within that byte represents the state of the key. This yields a value of 1. So, by reading bit position 1 of byte number 10, you determine the status of the function key F2.

Steven Solie: /* Closing the Keyboard Device */

2013-04-04T23:00:21Z

Closing the Keyboard Device

← Older revision		Revision as of 23:00, 4 April 2013
Line 76:		Line 76:
	All I/O requests must be complete before CloseDevice(). If any requests are still pending, abort them with AbortIO() and remove them with WaitIO().		All I/O requests must be complete before CloseDevice(). If any requests are still pending, abort them with AbortIO() and remove them with WaitIO().

			<syntaxhighlight>
	<pre>
	if (!(CheckIO(KeyIO)))		if (!(IExec->CheckIO(KeyIO)))
	{		{
	AbortIO(KeyIO); /* Ask device to abort request, if pending */		IExec->AbortIO(KeyIO); /* Ask device to abort request, if pending */
	}		}
	WaitIO(KeyIO); /* Wait for abort, then clean up */		IExec->WaitIO(KeyIO); /* Wait for abort, then clean up */
	CloseDevice(KeyIO);		IExec->CloseDevice(KeyIO);
			</syntaxhighlight>
	</pre>

	== Reading the Keyboard Matrix ==		== Reading the Keyboard Matrix ==