Suggestion for OS/2 and eComstation Drivers Arguments: Difference between revisions
No edit summary |
|||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
This document it is a suggestion to help standardize some driver behaviours on OS/2 and eComStation drivers. | This document it is a suggestion to help standardize some driver behaviours on OS/2 and eComStation drivers. | ||
==1. Boot Messages== | ==1. Boot Messages== | ||
It is common on eComStation and OS/2 that drivers that load on the boot procedure show a message during the boot. Here it is a recommendation on how to display messages for | It is common on eComStation and OS/2 that drivers that load on the boot procedure show a message during the boot. Here it is a recommendation on how to display messages for these drivers. | ||
===Default Message=== | ===Default Message=== | ||
The highly recommended behaviour is to make the default message a quiet mode without any message displayed. Only errors can be displayed in case the driver does not load. | The highly recommended behaviour is to make the default message a quiet mode without any message displayed. Only errors can be displayed in case the driver does not load. | ||
A suggestion for the default message is only to show a message if an error happens: | A suggestion for the default message is only to show a message if an error happens: | ||
| Line 24: | Line 24: | ||
UNIAUD32.SYS /V | UNIAUD32.SYS /V | ||
UNIAUD32: Universal Audio Driver for OS/2 and eComStation | UNIAUD32: Universal Audio Driver for OS/2 and eComStation | ||
UNIAUD32: Copyright 2005-2010 Netlabs http://www.netlabs.org | UNIAUD32: Copyright 2005-2010 Netlabs http://www.netlabs.org | ||
UNIAUD32: Copyright 2000-2010 The ALSA Project | UNIAUD32: Copyright 2000-2010 The ALSA Project | ||
UNIAUD32: Version 1.9.26-SVN551. Based on ALSA 1.0.21 | |||
UNIAUD32: Intel 82801AA-ICH with STAC9700,83,84 at irq 5 | UNIAUD32: Intel 82801AA-ICH with STAC9700,83,84 at irq 5 | ||
UNIAUD32: Detected Mixer: SigmaTel STAC9700,83,94 | UNIAUD32: Detected Mixer: SigmaTel STAC9700,83,94 | ||
===Quiet Mode “/Q” or “/q”=== | ===Quiet Mode “/Q” or “/q”=== | ||
It is important to add a quiet or non-verbose mode. There are users that once they have their system stable do not want or need to see a boot message. When you add the /Q option no message had to be show during the boot procedure. | It is important to add a quiet or non-verbose mode. There are users that once they have their system stable do not want or need to see a boot message. When you add the /Q option, no message had to be show during the boot procedure. | ||
* No message | * No generic/copyright/version message must be show. | ||
* The driver will not pause the boot procedure. | * The driver will not pause the boot procedure. | ||
Please also take care that the /Q is not sending also any blank space or return command as a message to be show. | Please also take care that the /Q is not sending also any blank space or return command as a message to be show. | ||
===Wait Mode “/W” or “/w”=== | ===Wait Mode “/W” or “/w”=== | ||
If this parameter is specified, the driver waits after loading for user to press any key with message "Press any key to continue..." to continue the boot procedure. | If this parameter is specified, the driver waits after loading for the user to press any key with the message "Press any key to continue..." to continue the boot procedure. | ||
'''Example:''' | '''Example:''' | ||
| Line 49: | Line 48: | ||
===Audible Alert “/AA” or “/aa”=== | ===Audible Alert “/AA” or “/aa”=== | ||
Some developers may want a beep or an audible alert to be | Some developers may want a beep or an audible alert to be heard on the boot procedure when the driver is loaded. By default, the driver should not make a beep sounds on the boot procedure. The user must have the option to enable or disable audible alerts. | ||
'''Example:''' | '''Example:''' | ||
| Line 56: | Line 55: | ||
==General Notes== | ==General Notes== | ||
;Copyright Information | ;Copyright Information | ||
: Remember that is not mandatory to include copyright information on the boot messages. I don't know where that idea came from or why IBM also started to that on their drivers. Copyright information can be included on text readme files of the driver. | : Remember that it is not mandatory to include copyright information on the boot messages. I don't know where that idea came from or why IBM also started to do that on their drivers. Copyright information can be included on text readme files of the driver. | ||
[[Category:Driver Articles]] | [[Category:Driver Articles]] | ||
Latest revision as of 14:20, 24 December 2023
This document it is a suggestion to help standardize some driver behaviours on OS/2 and eComStation drivers.
1. Boot Messages
It is common on eComStation and OS/2 that drivers that load on the boot procedure show a message during the boot. Here it is a recommendation on how to display messages for these drivers.
Default Message
The highly recommended behaviour is to make the default message a quiet mode without any message displayed. Only errors can be displayed in case the driver does not load.
A suggestion for the default message is only to show a message if an error happens:
DRIVER: <driver name> could not be loaded. XYZ Error.
Verbose Mode “/V” or “/v”
It is recommended to include on the driver a verbose mode to show full detail of the version, copyright notice and important information about the driver that is being loaded.
Example: “DRIVER.SYS /V” should generate a message like:
DRIVER: <driver name>. DRIVER: Copyright by <John Smith>. DRIVER: Version 1.4.33 Date 2011/Jan/24 DRIVER: Recognized Device: XYZ DRIVER: Driver Loaded without warnings
Example 2: UNIAUD32.SYS /V
UNIAUD32: Universal Audio Driver for OS/2 and eComStation UNIAUD32: Copyright 2005-2010 Netlabs http://www.netlabs.org UNIAUD32: Copyright 2000-2010 The ALSA Project UNIAUD32: Version 1.9.26-SVN551. Based on ALSA 1.0.21 UNIAUD32: Intel 82801AA-ICH with STAC9700,83,84 at irq 5 UNIAUD32: Detected Mixer: SigmaTel STAC9700,83,94
Quiet Mode “/Q” or “/q”
It is important to add a quiet or non-verbose mode. There are users that once they have their system stable do not want or need to see a boot message. When you add the /Q option, no message had to be show during the boot procedure.
- No generic/copyright/version message must be show.
- The driver will not pause the boot procedure.
Please also take care that the /Q is not sending also any blank space or return command as a message to be show.
Wait Mode “/W” or “/w”
If this parameter is specified, the driver waits after loading for the user to press any key with the message "Press any key to continue..." to continue the boot procedure.
Example: “DRIVER.SYS /W” should generate a message like:
DRIVER: <driver name>. Press any key to continue.
Example 2: “UNIAUD32.SYS /W“
UNIAUD32: Universal Audio Driver. Press any key to continue.
Audible Alert “/AA” or “/aa”
Some developers may want a beep or an audible alert to be heard on the boot procedure when the driver is loaded. By default, the driver should not make a beep sounds on the boot procedure. The user must have the option to enable or disable audible alerts.
Example: “DRIVER.SYS /AA” allows the driver to play beeps on the boot procedure.
General Notes
- Copyright Information
- Remember that it is not mandatory to include copyright information on the boot messages. I don't know where that idea came from or why IBM also started to do that on their drivers. Copyright information can be included on text readme files of the driver.