Timer Device - Revision history

Costel Mincea: /* Additional Information on the Timer Device */

2025-01-26T18:58:39Z

Additional Information on the Timer Device

← Older revision		Revision as of 18:58, 26 January 2025
Line 903:		Line 903:
	!colspan="2"\|Timer Device Information		!colspan="2"\|Timer Device Information
	\|-		\|-
	\|rowspan="4"\|Includes\|\|devices/timer.h		\|rowspan="2"\|Includes\|\|devices/timer.h
	\|-		\|-
	\|utility/date.h		\|utility/date.h

Costel Mincea at 18:56, 26 January 2025

2025-01-26T18:56:48Z

← Older revision		Revision as of 18:56, 26 January 2025
Line 53:		Line 53:
	The I/O request used by the timer device is called timerequest.		The I/O request used by the timer device is called timerequest.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct TimeRequest		struct TimeRequest
	{		{
Line 63:		Line 63:
	The timer device functions are passed a time structure, either timeval for non E-Clock units or EClockVal for E-Clock units.		The timer device functions are passed a time structure, either timeval for non E-Clock units or EClockVal for E-Clock units.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct TimeVal		struct TimeVal
	{		{
Line 126:		Line 126:

	* Create a message port using AllocSysObject(ASOT_PORT). Reply messages from the device must be directed to a message port.		* Create a message port using AllocSysObject(ASOT_PORT). Reply messages from the device must be directed to a message port.
	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct MsgPort *TimerMP; // Message port pointer		struct MsgPort *TimerMP; // Message port pointer
	struct Timerequest *TimerIO; // I/O structure pointer		struct Timerequest *TimerIO; // I/O structure pointer
Line 136:		Line 136:

	* Create an I/O request structure of type TimeRequest using AllocSysObject(ASOT_IOREQUEST).		* Create an I/O request structure of type TimeRequest using AllocSysObject(ASOT_IOREQUEST).
	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	// Create message block for device IO		// Create message block for device IO
	TimerIO = IExec->AllocSysObjectTags(ASOT_IOREQUEST,		TimerIO = IExec->AllocSysObjectTags(ASOT_IOREQUEST,
Line 146:		Line 146:
	* Open the timer device with one of the timer device units (listed above). Call OpenDevice() passing a pointer to the TimeRequest.		* Open the timer device with one of the timer device units (listed above). Call OpenDevice() passing a pointer to the TimeRequest.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	// Open the timer device with UNIT_MICROHZ		// Open the timer device with UNIT_MICROHZ
	if (error = IExec->OpenDevice(TIMERNAME, UNIT_MICROHZ, TimerIO, 0))		if (error = IExec->OpenDevice(TIMERNAME, UNIT_MICROHZ, TimerIO, 0))
Line 162:		Line 162:
	* Obtain the timer device interface pointer with GetInterface() using the base library pointer stored in io_Device.		* Obtain the timer device interface pointer with GetInterface() using the base library pointer stored in io_Device.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct TimerIFace ITimer / global interface pointer */		struct TimerIFace ITimer / global interface pointer */

Line 187:		Line 187:
	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().

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	if (!(IExec->CheckIO(TimerIO)))		if (!(IExec->CheckIO(TimerIO)))
	{		{
Line 202:		Line 202:
	The following is a simple CLI example program that waits for a 10 second request from the Timer Device. As you will see it opens a message port and the timer.device to accomplish this. After receiving the response message from the device, it closes and deallocates all resources used and quits.		The following is a simple CLI example program that waits for a 10 second request from the Timer Device. As you will see it opens a message port and the timer.device to accomplish this. After receiving the response message from the device, it closes and deallocates all resources used and quits.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	/* Simple_Wait.c		/* Simple_Wait.c
	*		*
Line 310:		Line 310:
	Here is a program that can be used to determine the system time. The command is executed by the timer device and, on return, the caller can find the data in his request block.		Here is a program that can be used to determine the system time. The command is executed by the timer device and, on return, the caller can find the data in his request block.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	/* Get_Systime.c		/* Get_Systime.c
	*		*
Line 399:		Line 399:
	For a minute and a half delay, set 60 in Seconds and 500,000 in Microseconds.		For a minute and a half delay, set 60 in Seconds and 500,000 in Microseconds.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	TimerIO->Request.io_Command = TR_ADDREQUEST;		TimerIO->Request.io_Command = TR_ADDREQUEST;
	TimerIO->Time.Seconds = 60; /* Delay a minute */		TimerIO->Time.Seconds = 60; /* Delay a minute */
Line 410:		Line 410:
	For our purposes, we will set an alarm for three hours from now by getting the current system time and adding three hours of seconds to it.		For our purposes, we will set an alarm for three hours from now by getting the current system time and adding three hours of seconds to it.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	#define SECSPERHOUR (60*60)		#define SECSPERHOUR (60*60)
	struct TimeVal *systime;		struct TimeVal *systime;
Line 454:		Line 454:
	It is also permissible to open the timer device multiple times. In some cases this may be easier than opening it once and using multiple requests. When multiple requests are given, SendIO() should be used to transmit each one to the timer.		It is also permissible to open the timer device multiple times. In some cases this may be easier than opening it once and using multiple requests. When multiple requests are given, SendIO() should be used to transmit each one to the timer.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	/* Multiple_Timers.c		/* Multiple_Timers.c
	*		*
Line 602:		Line 602:
	However, when two EClockVal structures are subtracted from each other and divided by the tics/sec (which remains constant), the result does have a relationship to actual time. The value of this calculation is a measure of fractions of a second that passed between the two readings.		However, when two EClockVal structures are subtracted from each other and divided by the tics/sec (which remains constant), the result does have a relationship to actual time. The value of this calculation is a measure of fractions of a second that passed between the two readings.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	/* E-Clock Fractions of a second fragment		/* E-Clock Fractions of a second fragment
	*		*
Line 650:		Line 650:
	Here is an example program showing how to use the Timer Device.		Here is an example program showing how to use the Timer Device.

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

Steven Solie: /* Opening the Timer Device */

2015-10-29T19:35:12Z

Opening the Timer Device

← Older revision		Revision as of 19:35, 29 October 2015
Line 127:		Line 127:
	* Create a message port using AllocSysObject(ASOT_PORT). Reply messages from the device must be directed to a message port.		* Create a message port using AllocSysObject(ASOT_PORT). Reply messages from the device must be directed to a message port.
	<syntaxhighlight>		<syntaxhighlight>
	struct MsgPort *TimerMP; // Message port pointer		struct MsgPort *TimerMP; // Message port pointer
	struct Timerequest *TimerIO; // I/O structure pointer		struct Timerequest *TimerIO; // I/O structure pointer

	// Create port for timer device communications		// Create port for timer device communications
	if (!(TimerMP = IExec->AllocSysObjectTags(ASOT_PORT, TAG_END)))		if (!(TimerMP = IExec->AllocSysObjectTags(ASOT_PORT, TAG_END)))
	cleanexit(" Error: Can't create port\n", RETURN_FAIL);		cleanexit(" Error: Can't create port\n", RETURN_FAIL);
	</syntaxhighlight>		</syntaxhighlight>

	* Create an I/O request structure of type TimeRequest using AllocSysObject(ASOT_IOREQUEST).		* Create an I/O request structure of type TimeRequest using AllocSysObject(ASOT_IOREQUEST).
	<syntaxhighlight>		<syntaxhighlight>
	// Create message block for device IO		// Create message block for device IO
	TimerIO = IExec->AllocSysObjectTags(ASOT_IOREQUEST,		TimerIO = IExec->AllocSysObjectTags(ASOT_IOREQUEST,
	ASOIOR_Size, sizeof(struct TimeRequest),		ASOIOR_Size, sizeof(struct TimeRequest),
	ASOIOR_ReplyPort, TimerMP,		ASOIOR_ReplyPort, TimerMP,
	TAG_END);		TAG_END);
	</syntaxhighlight>		</syntaxhighlight>

Line 147:		Line 147:

	<syntaxhighlight>		<syntaxhighlight>
	// Open the timer device with UNIT_MICROHZ		// Open the timer device with UNIT_MICROHZ
	if (error = IExec->OpenDevice(TIMERNAME, UNIT_MICROHZ, TimerIO, 0))		if (error = IExec->OpenDevice(TIMERNAME, UNIT_MICROHZ, TimerIO, 0))
	cleanexit(" Error: Can't open Timer.device\n", RETURN_FAIL);		cleanexit(" Error: Can't open Timer.device\n", RETURN_FAIL);
	</syntaxhighlight>		</syntaxhighlight>

Steven Solie at 18:33, 1 May 2014

2014-05-01T18:33:27Z

← Older revision		Revision as of 18:33, 1 May 2014
Line 197:		Line 197:
	IExec->CloseDevice((struct IORequest )TimerIO); / Close Timer device */		IExec->CloseDevice((struct IORequest )TimerIO); / Close Timer device */
	</syntaxhighlight>		</syntaxhighlight>


	=== Simple_Wait Device Example ===		=== Simple_Wait Device Example ===
Line 204:		Line 203:

	<syntaxhighlight>		<syntaxhighlight>

	/* Simple_Wait.c		/* Simple_Wait.c
	*		*

Steven Solie: /* Compatibility Warning */

2014-05-01T18:32:24Z

Compatibility Warning

← Older revision		Revision as of 18:32, 1 May 2014
Line 6:		Line 6:
	== Compatibility Warning ==		== Compatibility Warning ==

	AmigaOS code prior to version 50 of the operating system used ''struct timeval'' which conflicts with POSIX.		AmigaOS code prior to version 50 of the operating system used ''struct timeval'' which conflicts with [http://en.wikipedia.org/wiki/POSIX POSIX].

	The define '''__USE_OLD_TIMEVAL__''' in the header file devices/timer.h is provided to aid in migrating old AmigaOS code to the new ''struct TimeVal'' which should always be preferred.		The define '''__USE_OLD_TIMEVAL__''' in the header file devices/timer.h is provided to aid in migrating old AmigaOS code to the new ''struct TimeVal'' which should always be preferred.

Steven Solie at 23:43, 18 February 2014

2014-02-18T23:43:46Z

← Older revision		Revision as of 23:43, 18 February 2014
Line 91:		Line 91:
	=== Timer Device Units ===		=== Timer Device Units ===

	There are ~~six~~ units in the timer device.		There are several units in the timer device.

	'''Timer Device Units'''		'''Timer Device Units'''
Line 144:		Line 144:
	</syntaxhighlight>		</syntaxhighlight>

	* Open the timer device with one of the ~~six~~ timer device units (listed above). Call OpenDevice() passing a pointer to the TimeRequest.		* Open the timer device with one of the timer device units (listed above). Call OpenDevice() passing a pointer to the TimeRequest.

	<syntaxhighlight>		<syntaxhighlight>

Paul Sadlik: /* Timer Device Units */

2014-02-17T00:53:42Z

Timer Device Units

← Older revision		Revision as of 00:53, 17 February 2014
Line 91:		Line 91:
	=== Timer Device Units ===		=== Timer Device Units ===

	There are ~~five~~ units in the timer device.		There are six units in the timer device.

	'''Timer Device Units'''		'''Timer Device Units'''

Paul Sadlik: /* Opening the Timer Device */

2014-02-17T00:53:02Z

Opening the Timer Device

← Older revision		Revision as of 00:53, 17 February 2014
Line 144:		Line 144:
	</syntaxhighlight>		</syntaxhighlight>

	* Open the timer device with one of the ~~five~~ timer device units. Call OpenDevice() passing a pointer to the TimeRequest.		* Open the timer device with one of the six timer device units (listed above). Call OpenDevice() passing a pointer to the TimeRequest.

	<syntaxhighlight>		<syntaxhighlight>

Daniel Jedlicka at 15:42, 28 January 2014

2014-01-28T15:42:38Z

← Older revision		Revision as of 15:42, 28 January 2014
Line 66:		Line 66:
	struct TimeVal		struct TimeVal
	{		{
	~~ULONG~~ Seconds;		uint32 Seconds;
	~~ULONG~~ Microseconds;		uint32 Microseconds;
	};		};

	struct EClockVal		struct EClockVal
	{		{
	~~ULONG~~ ev_hi; /* Upper longword of E-Clock time */		uint32 ev_hi; /* Upper longword of E-Clock time */
	~~ULONG~~ ev_lo; /* Lower longword of E-Clock time */		uint32 ev_lo; /* Lower longword of E-Clock time */
	};		};
	</syntaxhighlight>		</syntaxhighlight>

Daniel Jedlicka: /* Example Timer Program */

2014-01-28T15:38:29Z

Example Timer Program

← Older revision		Revision as of 15:38, 28 January 2014
Line 792:		Line 792:
	int32 time_delay(struct TimeVal *tv, int32 unit)		int32 time_delay(struct TimeVal *tv, int32 unit)
	{		{
	struct TimeRequest *tr = NULL;

	/* get a pointer to an initialized timer request block */		/* get a pointer to an initialized timer request block */
	tr = create_timer( unit );		struct TimeRequest *tr = create_timer( unit );

	/* any nonzero return says timedelay routine didn't work. */		/* any nonzero return says timedelay routine didn't work. */
Line 826:		Line 824:
	int32 set_new_time(int32 secs)		int32 set_new_time(int32 secs)
	{		{
	struct TimeRequest *tr = ~~NULL~~;		struct TimeRequest *tr = create_timer( UNIT_MICROHZ );

	tr = create_timer( UNIT_MICROHZ );

	/* non zero return says error */		/* non zero return says error */
Line 848:		Line 844:
	int32 get_sys_time(struct TimeVal *tv)		int32 get_sys_time(struct TimeVal *tv)
	{		{
	struct TimeRequest *tr = ~~NULL~~;		struct TimeRequest *tr = create_timer( UNIT_MICROHZ );

	tr = create_timer( UNIT_MICROHZ );

	/* non zero return says error */		/* non zero return says error */