Revision 2 + 3 - Revision history

Costel Mincea: Text replacement - "" to ""

2025-01-26T19:11:27Z

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

← Older revision		Revision as of 19:11, 26 January 2025
Line 35:		Line 35:
	As when opening any other Exec device, on the call to OpenDevice() a SANA-II device receives an IORequest structure which the device initializes for the opener's use. The opener must copy this structure if it desires to use multiple asynchronous requests. The SANA-II IORequest is defined as follows:		As when opening any other Exec device, on the call to OpenDevice() a SANA-II device receives an IORequest structure which the device initializes for the opener's use. The opener must copy this structure if it desires to use multiple asynchronous requests. The SANA-II IORequest is defined as follows:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct IOSana2Req		struct IOSana2Req
	{		{
Line 130:		Line 130:
	The enhancements consist of several new tags that may be specified by a protocol stack on OpenDevice() to offer certain data transfer options. It is up to the device driver to chose which callbacks to use at what time. These tags are advisory only and may be ignored by the driver for any data buffer at any time:		The enhancements consist of several new tags that may be specified by a protocol stack on OpenDevice() to offer certain data transfer options. It is up to the device driver to chose which callbacks to use at what time. These tags are advisory only and may be ignored by the driver for any data buffer at any time:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	#define S2_CopyToBuff16 (S2_Dummy + 4)		#define S2_CopyToBuff16 (S2_Dummy + 4)
	#define S2_CopyFromBuff16 (S2_Dummy + 5)		#define S2_CopyFromBuff16 (S2_Dummy + 5)
Line 141:		Line 141:
	The following tags have been added to support direct writes into hardware buffers that do not allow arbitrarily sized or aligned accesses:		The following tags have been added to support direct writes into hardware buffers that do not allow arbitrarily sized or aligned accesses:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	#define S2_DMACopyToBuff32 (S2_Dummy + 8)		#define S2_DMACopyToBuff32 (S2_Dummy + 8)
	#define S2_DMACopyFromBuff32 (S2_Dummy + 9)		#define S2_DMACopyFromBuff32 (S2_Dummy + 9)
Line 288:		Line 288:
	S2_TRACKTYPE tells the device driver to gather statistics for a particular packet type. S2_UNTRACKTYPE tells it to stop (keeping statistics by type causes the driver to use additional resources). S2_GETTYPESTATS returns any statistics accumulated by the driver for a type being tracked (stats are lost when a type is S2_UNTRACKTYPE'd). Drivers are required to implement the functionality of type tracking. The stats are returned in a struct Sana2PacketTypeStats:		S2_TRACKTYPE tells the device driver to gather statistics for a particular packet type. S2_UNTRACKTYPE tells it to stop (keeping statistics by type causes the driver to use additional resources). S2_GETTYPESTATS returns any statistics accumulated by the driver for a type being tracked (stats are lost when a type is S2_UNTRACKTYPE'd). Drivers are required to implement the functionality of type tracking. The stats are returned in a struct Sana2PacketTypeStats:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct Sana2PacketTypeStats		struct Sana2PacketTypeStats
	{		{
Line 312:		Line 312:
	returns global statistics kept by the driver. Drivers are required to keep all applicable statistics. Since all are applicable to most hardware, most drivers will maintain all statistics. The stats are returned in a struct Sana2DeviceStats:		returns global statistics kept by the driver. Drivers are required to keep all applicable statistics. Since all are applicable to most hardware, most drivers will maintain all statistics. The stats are returned in a struct Sana2DeviceStats:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct Sana2DeviceStats		struct Sana2DeviceStats
	{		{
Line 342:		Line 342:
	returns any special statistics kept by a particular driver. Each new wire type will have a set of documented, required statistics for that wire type and a standard set of optional statistics for that wire type (optional because they might not be available from all hardware). The data returned by S2_GETSPECIALSTATS will require wire-specific interpretation. See <devices/sana2specialstats.h> on page devices<sub>s</sub>ana2specialstats<sub>p</sub>age for currently defined special statistics. The statistics are returned in the following structures:		returns any special statistics kept by a particular driver. Each new wire type will have a set of documented, required statistics for that wire type and a standard set of optional statistics for that wire type (optional because they might not be available from all hardware). The data returned by S2_GETSPECIALSTATS will require wire-specific interpretation. See <devices/sana2specialstats.h> on page devices<sub>s</sub>ana2specialstats<sub>p</sub>age for currently defined special statistics. The statistics are returned in the following structures:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct Sana2SpecialStatRecord		struct Sana2SpecialStatRecord
	{		{
Line 358:		Line 358:
	: An identifying, null-terminated string for the statistic. Should be plain ASCII with no formatting characters.		: An identifying, null-terminated string for the statistic. Should be plain ASCII with no formatting characters.

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct Sana2SpecialStatHeader		struct Sana2SpecialStatHeader
	{		{
Line 382:		Line 382:
	Driver users will want to use S2_DEVICEQUERY to determine the MTU and other characteristics of the network. The structure returned from S2_DEVICEQUERY is defined as:		Driver users will want to use S2_DEVICEQUERY to determine the MTU and other characteristics of the network. The structure returned from S2_DEVICEQUERY is defined as:

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

Steven Solie: /* sana2.device/S2_DEVICEQUERY */

2012-05-09T20:01:54Z

sana2.device/S2_DEVICEQUERY

← Older revision		Revision as of 20:01, 9 May 2012
Line 992:		Line 992:
	<devices/sana2.h> includes constants for these values. If your		<devices/sana2.h> includes constants for these values. If your
	hardware does not have a number assigned to it, you must contact		hardware does not have a number assigned to it, you must contact
	~~CATS~~ to get a hardware number.		the AmigaOS development team to get a hardware number.

	IO REQUEST		IO REQUEST
Line 1,001:		Line 1,001:
	ios2_Error - Zero if successful; non-zero otherwise.		ios2_Error - Zero if successful; non-zero otherwise.
	ios2_WireError - More specific error number.</pre>		ios2_WireError - More specific error number.</pre>

	== sana2.device/S2_GETGLOBALSTATS ==		== sana2.device/S2_GETGLOBALSTATS ==

Steven Solie: /* Hardware Type */

2012-05-09T20:01:32Z

Hardware Type

← Older revision		Revision as of 20:01, 9 May 2012
Line 200:		Line 200:
	= Hardware Type =		= Hardware Type =

	The HardwareType returned by the device's S2_DEVICEQUERY function is necessary for those protocols whose standards require different behavior on different hardware. It is also useful for determining appropriate packet type numbers to use with the device. The HardwareType values already issued for standard network hardware are the same as those in RFC 1060 (assigned numbers). Hardware developers implementing networks without a SANA-II hardware number must contact ~~''CATS''~~ to have a new hardware type number assigned. Driver users should all have reasonable defaults which can be used for hardware with which they are not familiar.		The HardwareType returned by the device's S2_DEVICEQUERY function is necessary for those protocols whose standards require different behavior on different hardware. It is also useful for determining appropriate packet type numbers to use with the device. The HardwareType values already issued for standard network hardware are the same as those in RFC 1060 (assigned numbers). Hardware developers implementing networks without a SANA-II hardware number must contact the AmigaOS development team to have a new hardware type number assigned. Driver users should all have reasonable defaults which can be used for hardware with which they are not familiar.

	= Errors =		= Errors =

Steven Solie: /* PacketFilter */

2012-05-02T22:21:23Z

PacketFilter

← Older revision		Revision as of 22:21, 2 May 2012
Line 1,511:		Line 1,511:
	system memory functions (since those functions rely on Forbid() to		system memory functions (since those functions rely on Forbid() to
	protect themselves) and that you must not compile this function		protect themselves) and that you must not compile this function
	with stack checking enabled. See the ~~RKM:Libraries~~ Exec:Interrupts		with stack checking enabled. See the Exec Interrupts
	chapter for more details on what is legal in a routine called from		chapter for more details on what is legal in a routine called from
	an interrupt handler.		an interrupt handler.

Steven Solie: /* CopyToBuff */

2012-05-02T22:21:05Z

CopyToBuff

← Older revision		Revision as of 22:21, 2 May 2012
Line 1,456:		Line 1,456:
	system memory functions (since those functions rely on Forbid() to		system memory functions (since those functions rely on Forbid() to
	protect themselves) and that you must not compile this function		protect themselves) and that you must not compile this function
	with stack checking enabled. See the ~~RKM:Libraries~~ Exec:Interrupts		with stack checking enabled. See the Exec Interrupts
	chapter for more details on what is legal in a routine called from		chapter for more details on what is legal in a routine called from
	an interrupt handler.		an interrupt handler.

Steven Solie: /* CopyFromBuff */

2012-05-02T22:20:49Z

CopyFromBuff

← Older revision		Revision as of 22:20, 2 May 2012
Line 1,410:		Line 1,410:
	system memory functions (since those functions rely on Forbid() to		system memory functions (since those functions rely on Forbid() to
	protect themselves) and that you must not compile this function		protect themselves) and that you must not compile this function
	with stack checking enabled. See the ~~RKM:Libraries~~ Exec:Interrupts		with stack checking enabled. See the Exec Interrupts
	chapter for more details on what is legal in a routine called from		chapter for more details on what is legal in a routine called from
	an interrupt handler.		an interrupt handler.

Steven Solie: /* sana.h header file */

2012-05-02T15:26:28Z

sana.h header file

Show changes

Steven Solie: /* sana2specialstats.h header file */

2012-05-02T15:26:11Z

sana2specialstats.h header file

← Older revision		Revision as of 15:26, 2 May 2012
Line 1,913:		Line 1,913:

	#endif /* SANA2_SANA2DEVICE_H */</pre>		#endif /* SANA2_SANA2DEVICE_H */</pre>

	= sana2specialstats.h header file =

	<pre>#ifndef SANA2_SANA2SPECIALSTATS_H
	#define SANA2_SANA2SPECIALSTATS_H 1
	/*
	** $VER: sana2specialstats.h 44.1 (27.9.1999)
	** Includes Release 44.1
	**
	** Defined IDs for SANA-II special statistics.
	**
	** (C) Copyright 1991-2000 Amiga, Inc.
	** All Rights Reserved
	*/

	#ifndef SANA2_SANA2DEVICE_H
	#include <devices/sana2.h>
	#endif /* !SANA2_SANA2DEVICE_H */

	/*
	** The SANA-II special statistic identifier is an unsigned 32 number.
	** The upper 16 bits identify the type of network wire type to which
	** the statistic applies and the lower 16 bits identify the particular
	** statistic.
	**
	** If you desire to add a new statistic identifier, contacts CATS.
	*/

	/*
	** defined ethernet special statistics
	*/

	#define S2SS_ETHERNET_BADMULTICAST ((((S2WireType_Ethernet)&0xffff)<<16)\|0x0000)
	/*
	** This count will record the number of times a received packet tripped
	** the hardware's multicast filtering mechanism but was not actually in
	** the current multicast table.
	*/

	#define S2SS_ETHERNET_RETRIES ((((S2WireType_Ethernet)&0xffff)<<16)\|0x0001)
	/*
	** This count records the total number of retries which have resulted
	** from transmissions on this board.
	*/

	#define S2SS_ETHERNET_FIFO_UNDERRUNS ((((S2WireType_Ethernet)&0xffff)<<16)\|0x0002)
	/*
	** This count records an error condition which indoicates that the host
	** computer did not feed the network interface card at a high enough rate.
	*/

	#endif /* SANA2_SANA2SPECIALSTATS_H */</pre>

Steven Solie: /* Configuration */

2012-05-02T15:24:55Z

Configuration

← Older revision		Revision as of 15:24, 2 May 2012
Line 382:		Line 382:
	Driver users will want to use S2_DEVICEQUERY to determine the MTU and other characteristics of the network. The structure returned from S2_DEVICEQUERY is defined as:		Driver users will want to use S2_DEVICEQUERY to determine the MTU and other characteristics of the network. The structure returned from S2_DEVICEQUERY is defined as:

			<syntaxhighlight>
	~~<blockquote>~~struct Sana2DeviceQuery~~<br />~~		struct Sana2DeviceQuery
	{<br />
			{
	ULONG SizeAvailable;<br />
	ULONG ~~SizeSupplied~~;~~<br />~~		ULONG SizeAvailable;
	ULONG ~~DevQueryFormat~~;~~<br />~~		ULONG SizeSupplied;
	ULONG ~~DeviceLevel~~;~~<br />~~		ULONG DevQueryFormat;
	ULONG ~~AddrFieldSize~~;~~<br />~~		ULONG DeviceLevel;
	ULONG ~~MTU~~;~~<br />~~		ULONG AddrFieldSize;
	ULONG ~~BPS~~;~~<br />~~		ULONG MTU;
	ULONG ~~HardwareType~~;~~<br />~~		ULONG BPS;
			ULONG HardwareType;
	};		};
			</syntaxhighlight>
	</blockquote>

	; SizeAvailable		; SizeAvailable

Steven Solie: /* Stats */

2012-05-02T15:24:01Z

Stats

← Older revision		Revision as of 15:24, 2 May 2012
Line 286:		Line 286:
	There are many statistics which may be very important to someone trying to debug, tune or optimize a protocol stack, as well as to the end user who may need to tune parameters or investigate a problem. Some of these statistics can only be kept by the SANA-II driver, thus there are several required and optional statistics and commands for this purpose.		There are many statistics which may be very important to someone trying to debug, tune or optimize a protocol stack, as well as to the end user who may need to tune parameters or investigate a problem. Some of these statistics can only be kept by the SANA-II driver, thus there are several required and optional statistics and commands for this purpose.

		⚫	S2_TRACKTYPE tells the device driver to gather statistics for a particular packet type. S2_UNTRACKTYPE tells it to stop (keeping statistics by type causes the driver to use additional resources). S2_GETTYPESTATS returns any statistics accumulated by the driver for a type being tracked (stats are lost when a type is S2_UNTRACKTYPE'd). Drivers are required to implement the functionality of type tracking. The stats are returned in a struct Sana2PacketTypeStats:
	S2_TRACKTYPE

			<syntaxhighlight>
⚫	tells the device driver to gather statistics for a particular packet type. S2_UNTRACKTYPE tells it to stop (keeping statistics by type causes the driver to use additional resources). S2_GETTYPESTATS returns any statistics accumulated by the driver for a type being tracked (stats are lost when a type is S2_UNTRACKTYPE'd). Drivers are required to implement the functionality of type tracking. The stats are returned in a struct Sana2PacketTypeStats:
		⚫	struct Sana2PacketTypeStats

			{
	<blockquote>
			ULONG PacketsSent;
⚫	struct Sana2PacketTypeStats~~<br />~~
			ULONG PacketsReceived;
	{<br />
	ULONG ~~PacketsSent~~;~~<br />~~		ULONG BytesSent;
	ULONG ~~PacketsReceived~~;~~<br />~~		ULONG BytesReceived;
	ULONG ~~BytesSent~~;~~<br />~~		ULONG PacketsDropped;
	ULONG BytesReceived;<br />
	ULONG PacketsDropped;<br />
	};		};
			</syntaxhighlight>
	</blockquote>

	; PacketsSent		; PacketsSent
Line 314:		Line 312:
	returns global statistics kept by the driver. Drivers are required to keep all applicable statistics. Since all are applicable to most hardware, most drivers will maintain all statistics. The stats are returned in a struct Sana2DeviceStats:		returns global statistics kept by the driver. Drivers are required to keep all applicable statistics. Since all are applicable to most hardware, most drivers will maintain all statistics. The stats are returned in a struct Sana2DeviceStats:

			<syntaxhighlight>
	<blockquote>
	struct Sana2DeviceStats~~<br />~~		struct Sana2DeviceStats
			{
	{<br />
	ULONG PacketsReceived;~~<br />~~		ULONG PacketsReceived;
	ULONG PacketsSent;~~<br />~~		ULONG PacketsSent;
	ULONG BadData;~~<br />~~		ULONG BadData;
	ULONG Overruns;~~<br />~~		ULONG Overruns;
	ULONG UnknownTypesReceived;~~<br />~~		ULONG UnknownTypesReceived;
	ULONG Reconfigurations;~~<br />~~		ULONG Reconfigurations;
	struct timeval LastStart;~~<br />~~		struct timeval LastStart;
	};		};
			</syntaxhighlight>
	</blockquote>

	; PacketsReceived		; PacketsReceived
Line 344:		Line 342:
	returns any special statistics kept by a particular driver. Each new wire type will have a set of documented, required statistics for that wire type and a standard set of optional statistics for that wire type (optional because they might not be available from all hardware). The data returned by S2_GETSPECIALSTATS will require wire-specific interpretation. See <devices/sana2specialstats.h> on page devices<sub>s</sub>ana2specialstats<sub>p</sub>age for currently defined special statistics. The statistics are returned in the following structures:		returns any special statistics kept by a particular driver. Each new wire type will have a set of documented, required statistics for that wire type and a standard set of optional statistics for that wire type (optional because they might not be available from all hardware). The data returned by S2_GETSPECIALSTATS will require wire-specific interpretation. See <devices/sana2specialstats.h> on page devices<sub>s</sub>ana2specialstats<sub>p</sub>age for currently defined special statistics. The statistics are returned in the following structures:

			<syntaxhighlight>
	<blockquote>
	struct Sana2SpecialStatRecord~~<br />~~		struct Sana2SpecialStatRecord
			{
	{<br />
	ULONG Type;~~<br />~~		ULONG Type;
	ULONG Count;~~<br />~~		ULONG Count;
	char * String;~~<br />~~		char * String;
	};		};
			</syntaxhighlight>
	</blockquote>

	; Type		; Type
Line 360:		Line 358:
	: An identifying, null-terminated string for the statistic. Should be plain ASCII with no formatting characters.		: An identifying, null-terminated string for the statistic. Should be plain ASCII with no formatting characters.

			<syntaxhighlight>
	<blockquote>
	struct Sana2SpecialStatHeader~~<br />~~		struct Sana2SpecialStatHeader
			{
	{<br />
	ULONG RecordCountMax;~~<br />~~		ULONG RecordCountMax;
	ULONG RecordCountSupplied;~~<br />~~		ULONG RecordCountSupplied;
	struct Sana2SpecialStatRecord[RecordCountMax];~~<br />~~		struct Sana2SpecialStatRecord[RecordCountMax];
	};		};
			</syntaxhighlight>
	</blockquote>

	; RecordCountMax		; RecordCountMax