Parallel Device - Revision history

Costel Mincea: Text replacement - "" to ""

2025-01-26T19:25:12Z

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

← Older revision		Revision as of 19:25, 26 January 2025
Line 41:		Line 41:
	The I/O request used by the parallel device is called IOExtPar.		The I/O request used by the parallel device is called IOExtPar.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct IOExtPar		struct IOExtPar
	{		{

Steven Solie: /* Device Interface */

2012-05-22T20:57:28Z

Device Interface

← Older revision		Revision as of 20:57, 22 May 2012
Line 37:		Line 37:
	== Device Interface ==		== Device Interface ==

	The parallel device operates like the other Amiga devices. To use it, you must first open the parallel device, then send I/O requests to it, and then close it when finished. See ~~the~~ [[~~Introduction~~ to ~~Amiga System Devices~~]] ~~chapter~~ for general information on device usage.		The parallel device operates like the other Amiga devices. To use it, you must first open the parallel device, then send I/O requests to it, and then close it when finished. See [[Exec_Device_I/O\|Exec Device I/O]] for general information on device usage.

	The I/O request used by the parallel device is called IOExtPar.		The I/O request used by the parallel device is called IOExtPar.

Alexandre Balaban: Categorizing

2012-05-10T22:06:28Z

Categorizing

← Older revision		Revision as of 22:06, 10 May 2012
Line 1:		Line 1:
	{{NeedUpdate}}		[[Category:Devices\|Parallel]]{{NeedUpdate}}
	== Parallel Device ==		== Parallel Device ==

Alexandre Balaban: /* Device Interface */

2012-05-10T22:03:57Z

Device Interface

← Older revision		Revision as of 22:03, 10 May 2012
Line 37:		Line 37:
	== Device Interface ==		== Device Interface ==

	The parallel device operates like the other Amiga devices. To use it, you must first open the parallel device, then send I/O requests to it, and then close it when finished. See the ~~“Introduction~~ to Amiga System ~~Devices”~~ chapter for general information on device usage.		The parallel device operates like the other Amiga devices. To use it, you must first open the parallel device, then send I/O requests to it, and then close it when finished. See the [[Introduction to Amiga System Devices]] chapter for general information on device usage.

	The I/O request used by the parallel device is called IOExtPar.		The I/O request used by the parallel device is called IOExtPar.

Steven Solie: /* Querying the Parallel Device */

2012-05-03T20:36:14Z

Querying the Parallel Device

@@ Line 241: / Line 241: @@
 The error is returned in the io_Error field of the IOExtPar structure.
-c'''Parallel Device Error Codes'''<br />
+'''Parallel Device Error Codes'''
-<pre>/*
+/*
  * Parallel.c
+ *
@@ Line 334: / Line 345: @@
     DeletePort(ParallelMP);
+    }
 == Additional Information on the Parallel Device ==

Steven Solie: /* Querying the Parallel Device */

2012-05-03T20:27:20Z

Querying the Parallel Device

← Older revision		Revision as of 20:27, 3 May 2012
Line 192:		Line 192:

	== Querying the Parallel Device ==		== Querying the Parallel Device ==



	You query the parallel device by passing an IOExtPar to the device with PDCMD_QUERY set in io_Command. The parallel device will respond with the status of the parallel port lines and registers.		You query the parallel device by passing an IOExtPar to the device with PDCMD_QUERY set in io_Command. The parallel device will respond with the status of the parallel port lines and registers.

			<pre>
	~~<pre>~~UWORD Parallel_Status;		UWORD Parallel_Status;

	ParallelIO->IOPar.io_Command = PDCMD_QUERY; /* indicate query */		ParallelIO->IOPar.io_Command = PDCMD_QUERY; /* indicate query */
	DoIO((struct IORequest *)ParallelIO);		DoIO((struct IORequest *)ParallelIO);

	Parallel_Status = ParallelIO->io_Status; /* store returned status */~~</pre>~~		Parallel_Status = ParallelIO->io_Status; /* store returned status */
			</pre>

	The 8 status bits of the parallel device are returned in io_Status.		The 8 status bits of the parallel device are returned in io_Status.

		⚫	'''Parallel Device Status Bits'''
	lll
			{\| class="wikitable"

			! Bit
⚫	3c'''Parallel Device Status Bits'''~~<br />~~
			! Active
	'''Bit''' & '''Active''' & '''Function'''<br />
			! Function
⚫	0 ~~&~~ high ~~&~~ Printer busy toggle (offline)~~<br />~~
			\|-
⚫	1 ~~&~~ high ~~&~~ Paper out~~<br />~~
		⚫	\| 0 \|\| high \|\| Printer busy toggle (offline)
⚫	2 ~~&~~ high ~~&~~ ~~9.2cmPrinter~~ Select on the ''A1000''. On the ''A500'' and ''A2000'', select is also connected to to the parallel port’s ''Ring Indicator''. Be cautious when making cables.~~<br />~~
			\|-
⚫	3 ~~&~~ – ~~&~~ read=0; write=1~~<br />~~
		⚫	\| 1 \|\| high \|\| Paper out
⚫	4–7 ~~&~~ – ~~&~~ (reserved)~~<br />~~
			\|-

		⚫	\| 2 \|\| high \|\| Printer Select on the ''A1000''. On the ''A500'' and ''A2000'', select is also connected to to the parallel port’s ''Ring Indicator''. Be cautious when making cables.
			\|-
		⚫	\| 3 \|\| – \|\| read=0; write=1
			\|-
		⚫	\| 4–7 \|\| – \|\| (reserved)
			\|}

	The parallel device also returns error codes whenever an operation is attempted.		The parallel device also returns error codes whenever an operation is attempted.

			<pre>
	~~<pre>~~struct IOPArray Terminators =		struct IOPArray Terminators =
	{		{
	0x51454141, /* Q E A A */		0x51454141, /* Q E A A */
Line 228:		Line 236:
	ParallellIO->IOPar.io_Command = PDCMD_SETPARAMS; /* Set parameters */		ParallellIO->IOPar.io_Command = PDCMD_SETPARAMS; /* Set parameters */
	if (DoIO((struct IORequest *)ParallelIO))		if (DoIO((struct IORequest *)ParallelIO))
	printf("Set Params failed. Error: %ld ",ParallelIO->IOPar.io_Error);~~</pre>~~		printf("Set Params failed. Error: %ld ",ParallelIO->IOPar.io_Error);
			</pre>
⚫	The error is returned in the io_Error field of the IOExtPar structure.

		⚫	The error is returned in the io_Error field of the IOExtPar structure.
	lll

	3c'''Parallel Device Error Codes'''<br />		3c'''Parallel Device Error Codes'''<br />
Line 327:		Line 335:
	}		}
	}</pre>		}</pre>

	== Additional Information on the Parallel Device ==		== Additional Information on the Parallel Device ==

Steven Solie: /* Setting Parallel Parameters */

2012-05-03T20:25:10Z

Setting Parallel Parameters

← Older revision		Revision as of 20:25, 3 May 2012
Line 141:		Line 141:
	You can control the parallel parameters shown in the following table. The parameter name within the parallel IOExtPar data structure is shown below. All of the fields described in this section are filled with defaults when you call OpenDevice(). Thus, you need not worry about any parameter that you do not need to change. The parameters are defined in the include file devices/parallel.h.		You can control the parallel parameters shown in the following table. The parameter name within the parallel IOExtPar data structure is shown below. All of the fields described in this section are filled with defaults when you call OpenDevice(). Thus, you need not worry about any parameter that you do not need to change. The parameters are defined in the include file devices/parallel.h.

		⚫	'''Parallel Parameters (IOExtPar)'''
	ll

			; io_PExtFlags
⚫	2c'''Parallel Parameters (IOExtPar)'''~~<br />~~
			: Reserved for future use.
	'''IOExtPar''' &<br />
	'''Field Name''' & '''Parallel Device Parameter It Controls'''<br />
	io_PExtFlags & 9cmReserved for future use.<br />
⚫	~~io_PTermArray~~ ~~& 9cmA~~ byte-array of eight termination characters, must be in descending order. If EOFMODE is set in the parallel flags, this array specifies eight possible choices of characters to use as an end-of-file mark. See the section above titled “Ending A Read Or Write with Termination Characters” and the PDCMD_SETPARAMS summary page in the Autodocs.~~<br />~~
⚫	~~io_Status~~ ~~& 9cmContains~~ status information. It is filled in by the PDCMD_QUERY command.~~<br />~~
⚫	~~io_ParFlags~~ ~~& 9cmSee~~ “Parallel Flags” below.~~<br />~~

			; io_PTermArray
		⚫	: A byte-array of eight termination characters, must be in descending order. If EOFMODE is set in the parallel flags, this array specifies eight possible choices of characters to use as an end-of-file mark. See the section above titled “Ending A Read Or Write with Termination Characters” and the PDCMD_SETPARAMS summary page in the Autodocs.

			; io_Status
		⚫	: Contains status information. It is filled in by the PDCMD_QUERY command.

			; io_ParFlags
		⚫	: See “Parallel Flags” below.

	You set the parallel parameters by passing an IOExtPar to the device with PDCMD_SETPARAMS set in io_Command and with the flags and parameters set to the values you want.		You set the parallel parameters by passing an IOExtPar to the device with PDCMD_SETPARAMS set in io_Command and with the flags and parameters set to the values you want.

			<pre>
	~~<pre>~~ParallelIO->io_ParFlags &= ~PARF_EOFMODE; /* Set EOF mode */		ParallelIO->io_ParFlags &= ~PARF_EOFMODE; /* Set EOF mode */
	ParallelIO->IOPar.io_Command = PDCMD_SETPARAMS; /* Set params command */		ParallelIO->IOPar.io_Command = PDCMD_SETPARAMS; /* Set params command */
	if (DoIO(ParallelIO);		if (DoIO(ParallelIO);
	printf("Error setting parameters!\n");~~</pre>~~		printf("Error setting parameters!\n");
			</pre>

	The above code fragment modifies one bit in io_ParFlags, then sends the command.		The above code fragment modifies one bit in io_ParFlags, then sends the command.

			{\| class="wikitable"
	~~<sub>b</sub>oxProper~~ Time for Parameter Changes.A parameter change should not be performed while an I/O request is actually being processed, because it might invalidate already active request handling. Therefore you should use PDCMD_SETPARAMS only when you have no parallel I/O requests pending.		\| ''Proper Time for Parameter Changes.'' A parameter change should not be performed while an I/O request is actually being processed, because it might invalidate already active request handling. Therefore you should use PDCMD_SETPARAMS only when you have no parallel I/O requests pending.
			\|}

	=== Parallel Flags (bit definitions for io_ParFlags) ===		=== Parallel Flags (bit definitions for io_ParFlags) ===



	The flags shown in the following table can be set to affect the operation of the parallel device. Note that the default state of all of these flags is zero. The flags are defined in the include file devices/parallel.h.		The flags shown in the following table can be set to affect the operation of the parallel device. Note that the default state of all of these flags is zero. The flags are defined in the include file devices/parallel.h.

		⚫	'''Parallel Flags (io_ParFlags)'''

			; PARF_EOFMODE
		⚫	: Set this bit if you want the parallel device to check I/O characters against io_TermArray and terminate the I/O request immediately if an end-of-file character has been encountered. ''Note'': This bit can be set and reset directly in the user’s IOExtPar block without a call to PDCMD_SETPARAMS.

			; PARF_ACKMODE
		⚫	: Set this bit if you want to use ACK handshaking.

			; PARF_FASTMODE
	ll
		⚫	: Set this bit if you want to use high-speed mode for transfers to high-speed printers. This mode will send out data as long as the BUSY signal is low. The printer must be able to raise the BUSY signal within three microseconds or data will be lost. Should only be used when the device has been opened for exclusive-access.

			; PARF_SLOWMODE
⚫	2c'''Parallel Flags (io_ParFlags)'''~~<br />~~
		⚫	: Set this bit if you want to use slow-speed mode for transfers to very slow printers. Should not be used with high-speed printers.
	'''Flag Name''' & '''Effect on Device Operation'''<br />
⚫	~~PARF_EOFMODE &~~ ~~9cmSet~~ this bit if you want the parallel device to check I/O characters against io_TermArray and terminate the I/O request immediately if an end-of-file character has been encountered. ''Note'': This bit can be set and reset directly in the user’s IOExtPar block without a call to PDCMD_SETPARAMS.~~<br />~~
⚫	~~PARF_ACKMODE~~ ~~& 9cmSet~~ this bit if you want to use ACK handshaking.~~<br />~~
⚫	~~PARF_FASTMODE~~ ~~& 9cmSet~~ this bit if you want to use high-speed mode for transfers to high-speed printers. This mode will send out data as long as the BUSY signal is low. The printer must be able to raise the BUSY signal within three microseconds or data will be lost. Should only be used when the device has been opened for exclusive-access.~~<br />~~
⚫	~~PARF_SLOWMODE~~ ~~& 9cmSet~~ this bit if you want to use slow-speed mode for transfers to very slow printers. Should not be used with high-speed printers.~~<br />~~
⚫	~~PARF_SHARED~~ ~~& 9cmSet~~ this bit if you want to allow other tasks to simultaneously access the parallel port. The default is exclusive access. If someone already has the port, whether for exclusive or shared access, and you ask for exclusive access, your OpenDevice() call will fail (must be modified before OpenDevice()).~~<br />~~

			; PARF_SHARED
		⚫	: Set this bit if you want to allow other tasks to simultaneously access the parallel port. The default is exclusive access. If someone already has the port, whether for exclusive or shared access, and you ask for exclusive access, your OpenDevice() call will fail (must be modified before OpenDevice()).

	== Querying the Parallel Device ==		== Querying the Parallel Device ==

Steven Solie: /* Ending A Read or Write with Termination Characters */

2012-05-03T20:22:15Z

Ending A Read or Write with Termination Characters

← Older revision		Revision as of 20:22, 3 May 2012
Line 122:		Line 122:

	== Ending A Read or Write with Termination Characters ==		== Ending A Read or Write with Termination Characters ==



	Reads and writes from the parallel device may terminate early if an error occurs or if an end-of-file is sensed. For example, if a break is detected on the line, any current read request will be returned with the error ParErr_DetectedBreak. The count of characters read to that point will be in the io_Actual field of the request.		Reads and writes from the parallel device may terminate early if an error occurs or if an end-of-file is sensed. For example, if a break is detected on the line, any current read request will be returned with the error ParErr_DetectedBreak. The count of characters read to that point will be in the io_Actual field of the request.



	You can specify a set of possible end-of-file characters that the parallel device is to look for in the input or output stream using the PDCMD_SETPARAMS command. These are contained in an io_PTermArray that you provide. io_PTermArray is used only when the PARF_EOFMODE flag is selected (see “Parallel Flags” below).		You can specify a set of possible end-of-file characters that the parallel device is to look for in the input or output stream using the PDCMD_SETPARAMS command. These are contained in an io_PTermArray that you provide. io_PTermArray is used only when the PARF_EOFMODE flag is selected (see “Parallel Flags” below).
Line 137:		Line 133:
	The read will terminate before the io_Length number of characters is read if a ‘Q’, ‘E’, or ‘A’ is detected.		The read will terminate before the io_Length number of characters is read if a ‘Q’, ‘E’, or ‘A’ is detected.

			{\| class="wikitable"
	~~<sub>b</sub>oxIt’s~~ Usually For Output.Most applications for the parallel device use the device for output, hence the termination feature is usually done on the output stream.		\| ''It’s Usually For Output.'' Most applications for the parallel device use the device for output, hence the termination feature is usually done on the output stream.
			\|}

	== Setting Parallel Parameters ==		== Setting Parallel Parameters ==

Steven Solie: /* Device Interface */

2012-05-03T20:21:46Z

Device Interface

← Older revision		Revision as of 20:21, 3 May 2012
Line 41:		Line 41:
	The I/O request used by the parallel device is called IOExtPar.		The I/O request used by the parallel device is called IOExtPar.

			<syntaxhighlight>

		⚫	struct IOExtPar

⚫	~~<pre>~~struct IOExtPar
	{		{
	struct IOStdReq IOPar;		struct IOStdReq IOPar;
Line 50:		Line 49:
	UBYTE io_ParFlags; /* parallel device flags */		UBYTE io_ParFlags; /* parallel device flags */
	struct IOPArray io_PTermArray; /* termination character array */		struct IOPArray io_PTermArray; /* termination character array */
	};~~</pre>~~		};
			</syntaxhighlight>

	See the include file devices/parallel.h for the complete structure definition.		See the include file devices/parallel.h for the complete structure definition.

Line 61:		Line 62:
	* Open the parallel device. Call OpenDevice(), passing the I/O request.		* Open the parallel device. Call OpenDevice(), passing the I/O request.

			<pre>
	~~<pre>~~struct MsgPort ParallelMP; / Pointer to reply port */		struct MsgPort ParallelMP; / Pointer to reply port */
	struct IOExtPar ParallelIO; / Pointer to I/O request */		struct IOExtPar ParallelIO; / Pointer to I/O request */

Line 68:		Line 70:
	CreateExtIO(ParallelMP,sizeof(struct IOExtPar)) )		CreateExtIO(ParallelMP,sizeof(struct IOExtPar)) )
	if (OpenDevice(PARALLELNAME,0L,(struct IORequest *)ParallelIO,0) )		if (OpenDevice(PARALLELNAME,0L,(struct IORequest *)ParallelIO,0) )
	printf("%s did not open\n",PARALLELNAME);~~</pre>~~		printf("%s did not open\n",PARALLELNAME);
			</pre>

	During the open, the parallel device pays attention to just one flag; PARF_SHARED. For consistency, the other flag bits should also be properly set. Full descriptions of all flags will be given later. When the parallel device is opened, it fills the latest default parameter settings into the IOExtPar block.		During the open, the parallel device pays attention to just one flag; PARF_SHARED. For consistency, the other flag bits should also be properly set. Full descriptions of all flags will be given later. When the parallel device is opened, it fills the latest default parameter settings into the IOExtPar block.

Line 75:		Line 79:
	You read from the parallel device by passing an IOExtPar to the device with CMD_READ set in io_Command, the number of bytes to be read set in io_Length and the address of the read buffer set in io_Data.		You read from the parallel device by passing an IOExtPar to the device with CMD_READ set in io_Command, the number of bytes to be read set in io_Length and the address of the read buffer set in io_Data.

			<pre>
	~~<pre>~~#define READ_BUFFER_SIZE 256		#define READ_BUFFER_SIZE 256
	char ParallelReadBuffer[READ_BUFFER_SIZE]; /* Reserve SIZE bytes of storage */		char ParallelReadBuffer[READ_BUFFER_SIZE]; /* Reserve SIZE bytes of storage */

Line 81:		Line 86:
	ParallelIO->IOPar.io_Data = (APTR)&ParallelReadBuffer[0];		ParallelIO->IOPar.io_Data = (APTR)&ParallelReadBuffer[0];
	ParallelIO->IOPar.io_Command = CMD_READ;		ParallelIO->IOPar.io_Command = CMD_READ;
	DoIO((struct IORequest *)ParallelIO);~~</pre>~~		DoIO((struct IORequest *)ParallelIO);
			</pre>

	If you use this example, your task will be put to sleep waiting until the parallel device reads 256 bytes (or terminates early). Early termination can be caused by error conditions.		If you use this example, your task will be put to sleep waiting until the parallel device reads 256 bytes (or terminates early). Early termination can be caused by error conditions.

Line 90:		Line 97:
	To write a NULL-terminated string, set the length to -1; the device will output from your buffer until it encounters and transmits a value of zero (0x00).		To write a NULL-terminated string, set the length to -1; the device will output from your buffer until it encounters and transmits a value of zero (0x00).

			<pre>
	~~<pre>~~ParallelIO->IOPar.io_Length = -1;		ParallelIO->IOPar.io_Length = -1;
	ParallelIO->IOPar.io_Data = (APTR)"Parallel lines cross 7 times... ";		ParallelIO->IOPar.io_Data = (APTR)"Parallel lines cross 7 times... ";
	ParallelIO->IOPar.io_Command = CMD_WRITE;		ParallelIO->IOPar.io_Command = CMD_WRITE;
	DoIO((struct IORequest )ParallelIO); / execute write */~~</pre>~~		DoIO((struct IORequest )ParallelIO); / execute write */
			</pre>

	The length of the request is -1, meaning we are writing a NULL-terminated string. The number of characters sent can be found in io_Actual.		The length of the request is -1, meaning we are writing a NULL-terminated string. The number of characters sent can be found in io_Actual.

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

			<pre>
	~~<pre>~~if (!(CheckIO(ParallelIO)))		if (!(CheckIO(ParallelIO)))
	{		{
	AbortIO(ParallelIO); /* Ask device to abort request, if pending */		AbortIO(ParallelIO); /* Ask device to abort request, if pending */
	}		}
	WaitIO(ParallelIO); /* Wait for abort, then clean up */		WaitIO(ParallelIO); /* Wait for abort, then clean up */
	CloseDevice((struct IORequest *)ParallelIO);~~</pre>~~		CloseDevice((struct IORequest *)ParallelIO);
			</pre>

	== Ending A Read or Write with Termination Characters ==		== Ending A Read or Write with Termination Characters ==

Steven Solie: /* Additional Information on the Parallel Device */

2012-05-02T03:29:25Z

Additional Information on the Parallel Device

← Older revision		Revision as of 03:29, 2 May 2012
Line 308:		Line 308:
	== Additional Information on the Parallel Device ==		== Additional Information on the Parallel Device ==

	Additional programming information on the parallel device can be found in the include files and the Autodocs for the parallel device. Both are contained in the ~~''Amiga ROM Kernel Reference Manual: Includes and Autodocs''~~.		Additional programming information on the parallel device can be found in the include files and the Autodocs for the parallel device. Both are contained in the SDK.

			{\| class="wikitable"
	\|ll\|
			! Includes
			\|-
		⚫	\| devices/parallel.h
			\|}

			{\| class="wikitable"
	2c'''Parallel Device Information'''<br />
			! AutoDocs
	Includes & devices/parallel.h<br />
			\|-
⚫	~~&~~ devices/parallel.~~i<br />~~
	~~AutoDocs &~~ parallel.doc~~<br />~~		\| parallel.doc
			\|}