WikiTI - User contributions [en]

83Plus:Software:usb8x/Build

2010-01-17T21:39:32Z

Typhox:

Building usb8x from source is (hopefully) an easy process. You need [http://www.zilog.com/download/z8/devtools/ZDS368.exe ZDS] or a ZDS-compatible assembler. Just open the usb8x.zws project file in ZDS and compile to produce a .hex file which you can sign with wappsign or your favorite signing tool.

Compile time settings are listed in settings.inc. They are:
{| border="1" cellpadding="2" cellspacing="0"
!Setting Name !! Default !! Description
|-
|LOGGING_ON || 0 || If set to 1, logging support will be compiled. Even if logging support is compiled, logs will not actually be kept unless [[../Asm_Interface/SetupLog|SetupLog]] is called. Logging support, even if logging is not enabled, can significantly slow down high speed drivers like MSD, so logging support should be disabled except in debug versions.
|-
|ASSERT_ON || 0 || If set to 1, assertion support will be compiled. Assertions are used throughout the usb8x code to make sure certain inputs and outputs are within reasonable bounds. If they are not the assertion is triggered, debug information is displayed on the screen, and the calculator halts. Assertions slightly slow down usb8x operation, so they should probably be disabled in release versions.
|-
|SAFETYINT_ON || 0 || If set to 1, a safety interrupt will be compiled and automatically loaded when the driver is started. This interrupt checks memory for sane values using assertions. Thus, if you enable the safety interrupt, you should also enable assertions. The safety interrupt uses statVars, so it should be disabled in release versions to prevent conflicts with external software.
|-
|HUBCODE_ON || 0 || If set to 1, code for handling USB hubs will be compiled. This code provides routines to set and clear hub features, and also causes AutoSetup to automatically bypass an attached hub and instead setup the first attached device. The current code only works with some devices (doesn't work with HID devices) so it is disabled by default.
|-
|CACHE_ON || 1 || If set to 1, code for MSD caching is compiled. Even if caching support is compiled, the cache will not be active unless the external program using the MSD driver specifically enables it. Current cache code should be bug-free for reads, but may still have some bugs when writing.
|-
|VERNIER_ON / KBD_ON / MOUSE_ON / MSD_ON / SILVER_ON / PAD_ON || 1 || If set to 1, the cooresponding driver will be compiled. The release version of usb8x includes all drivers. If a driver is not compiled and an external program tries to access it, a FeatureDisabled error will be returned.
|-
|ALWAYSCANCELINT_ON || 0 || If set to 1, the usb8x interrupt will always tell the TIOS to ignore USB events, even if the event is something that usb8x does not handle.
|-
|INTERRUPTMACRO_TYPE || 1 || If set to 0, usb8x will not disable or enable interrupts around sensitive routines. If set to 1, usb8x will disable and enable interrupts with di/ei around sensitive routines. If set to 2, usb8x will save the status of the interrupt before disabling it, and only re-enable interrupts if they were on to begin with. Set to 1 by default because it seems to work the best.
|-
|LOGxxxxxx_ON || 1 || Each of the many log settings controls one particular log file type. If a log setting is seto to 1, then the cooresponding log type will be included in the log file (assuming logging is compiled and enabled). If set to 0, that log type will be ignored. These settings are good if you're debugging one particular system and don't want the log file to be cluttered up with extraneous information.
|}

83Plus:Software:USBTools

2010-01-17T20:16:15Z

Typhox:

USBTools is a companion application to [[83Plus:Software:usb8x|usb8x]]. It provides tools for developers as well as demos to test usb8x's drivers. USBTools requires version 0.11 or higher of usb8x.

The current version of USBTools is 0.01, and is available for [http://sourceforge.net/projects/usb8x Download] on the usb8x Sourceforge page.

When you run USBTools, you will be greeted by the following menu screen:
USB Tools
1) [[83Plus:Software:USBTools/Stuff|Stuff]]
2) [[83Plus:Software:USBTools/Tools|Tools]]
3) [[83Plus:Software:USBTools/Demos|Demos]]
4) [[83Plus:Software:USBTools/About|About]]
5) Quit

[[Category:83Plus:Software|USBTools]]

83Plus:Software:usb8x/Asm Interface/KBD

2010-01-17T18:07:00Z

Typhox:

The usb8x keyboard driver is compatible with any keyboard conforming to the USB HID keyboard standard. However, it is not compatible with devices that have a keyboard connected to an internal hub (combination keyboard/mice, for example).

The keyboard driver is initialized via [[83Plus:Software:usb8x/Asm_Interface/KBD/KBDInit|KBDInit]]. This entry point initializes both the driver and the keyboard hardware, so you may want to check to see if a device is connected via [[83Plus:Software:usb8x/Asm_Interface/IsDeviceConnected|IsDeviceConnected]] first.

After initializing the keyboard, use [[83Plus:Software:usb8x/Asm_Interface/KBD/KBDGetKey|KBDGetKey]] to get keypress information. The driver maintains a 6-key keyboard buffer, so be sure to check for new keypresses with KBDGetKey regularly so the buffer doesn't fill.

== Entry Points ==
{| border="1" cellpadding="2" cellspacing="0"
|-
| [[83Plus:Software:usb8x/Asm_Interface/KBD/KBDCheckDirect|KBDCheckDirect]] || Check current keyboard matrix
|-
| [[83Plus:Software:usb8x/Asm_Interface/KBD/KBDInit|KBDInit]] || Initialize the keyboard driver and hardware
|-
| [[83Plus:Software:usb8x/Asm_Interface/KBD/KBDGetKey|KBDGetKey]] || Get key presses
|-
| [[83Plus:Software:usb8x/Asm_Interface/KBD/KBDGetMods|KBDGetMods]] || Get current modifier key status
|-
| [[83Plus:Software:usb8x/Asm_Interface/KBD/KBDVersion|KBDVersion]] || Get driver version and RAM requirements
|}

83Plus:Software:usb8x/Asm Interface/KBD

2010-01-17T18:06:09Z

Typhox:

The usb8x keyboard driver is compatible with any keyboard conforming to the USB HID keyboard standard. However, it is not compatible with devices that have a keyboard connected to an internal hub (combination keyboard/mice, for example).

The keyboard driver is initialized via [[83Plus:Software:usb8x/Asm_Interface/KBD/KBDInit|KBDInit]]. This entry point initializes both the driver and the keyboard hardware, so you may want to check to see if a device is connected via [[../IsDeviceConnected|IsDeviceConnected]] first.

After initializing the keyboard, use [[83Plus:Software:usb8x/Asm_Interface/KBD/KBDGetKey|KBDGetKey]] to get keypress information. The driver maintains a 6-key keyboard buffer, so be sure to check for new keypresses with KBDGetKey regularly so the buffer doesn't fill.

== Entry Points ==
{| border="1" cellpadding="2" cellspacing="0"
|-
| [[83Plus:Software:usb8x/Asm_Interface/KBD/KBDCheckDirect|KBDCheckDirect]] || Check current keyboard matrix
|-
| [[83Plus:Software:usb8x/Asm_Interface/KBD/KBDInit|KBDInit]] || Initialize the keyboard driver and hardware
|-
| [[83Plus:Software:usb8x/Asm_Interface/KBD/KBDGetKey|KBDGetKey]] || Get key presses
|-
| [[83Plus:Software:usb8x/Asm_Interface/KBD/KBDGetMods|KBDGetMods]] || Get current modifier key status
|-
| [[83Plus:Software:usb8x/Asm_Interface/KBD/KBDVersion|KBDVersion]] || Get driver version and RAM requirements
|}

83Plus:Software:usb8x/Asm Interface

2010-01-17T17:49:11Z

Typhox: Link target was wrong

Many usb8x functions can be used by other programs/applications through usb8x's assembly language U_CALL interface. Macros are provded in usb8x.inc to simplify the process. The macros require a 32-byte RAM buffer defined as USBDriverCall. The U_CALL system must be initialized by the application as follows:
U_CALL_INIT CallBackRoutine
Where CallBackRoutine is a subroutine that will be called when data arrives on the USB port. Some internal drivers override the user supplied callback address, but you must still provide one. If U_CALL_INIT returns carry, usb8x is not loaded on the calculator.

After the U_CALL system has been initialized with U_CALL_INIT, use the U_CALL macro to call usb8x entry points. The first entry point you should call is [[83Plus:Software:usb8x/Asm_Interface/DriverInit|DriverInit]] as most other entry points require the driver be initialized before use. '''Be sure to call [[83Plus:Software:usb8x/Asm_Interface/HostKill|HostKill]] and [[83Plus:Software:usb8x/Asm_Interface/DriverKill|DriverKill]] before quitting your program.'''

==Internal Drivers==
Several drivers are provided by usb8x to control specific devices. If you are interested in using usb8x in a game or program (as opposed to writing a driver for a new device), the pages below document the entry points you are most likely interested in.

{| border="1" cellpadding="2" cellspacing="0"
|-
|[[83Plus:Software:usb8x/Asm_Interface/MSD|Mass Storage]] || Communicate with flash drives, hard drives, and other devices conforming to the USB MSD standard.
|-
|[[83Plus:Software:usb8x/Asm_Interface/Mouse|Mouse]] || Communicate with mice and other pointing devices conforming to the USB HID mouse standard.
|-
|[[83Plus:Software:usb8x/Asm_Interface/KBD|Keyboard]] || Communicate with keyboards comforming to the USB HID keyboard standard.
|-
|[[83Plus:Software:usb8x/Asm_Interface/Silver|SilverLink]] || Use the TI-Graphlink SilverLink to communicate with another calculator.
|-
|[[83Plus:Software:usb8x/Asm_Interface/Pad|GamePad]] || Communicate with compatible gamepad controllers.
|-
|[[83Plus:Software:usb8x/Asm_Interface/Vernier|Vernier]] || Communicate with [http://www.vernier.com/easy/easytemp.html EasyTemp] or other Vernier devices.
|}

==High Level Entry Points==
The following entry points may be useful for any program using usb8x, whether it be using an internal driver or low level entry points to create a new driver.
{| border="1" cellpadding="2" cellspacing="0"
|-
|[[83Plus:Software:usb8x/Asm_Interface/DriverInit|DriverInit]] || Initialize the USB driver
|-
|[[83Plus:Software:usb8x/Asm_Interface/DriverKill|DriverKill]] || Uninitialize the USB driver
|-
|[[83Plus:Software:usb8x/Asm_Interface/GetErrorCode|GetErrorCode]] || Returns the current error and sub-error codes
|-
|[[83Plus:Software:usb8x/Asm_Interface/GetVersion|GetVersion]] || Returns the current driver version
|-
|[[83Plus:Software:usb8x/Asm_Interface/HostKill|HostKill]] || Uninitialize a USB device
|-
|[[83Plus:Software:usb8x/Asm_Interface/IsDeviceConnected|IsDeviceConnected]] || Tests if a device is connected to the USB port
|-
|[[83Plus:Software:usb8x/Asm_Interface/WaitTimerB|WaitTimerB]] || Precise delay
|}

==Low Level Entry Points==
These are the entry points you're most likely interested in using if you want to create a device driver for a new device.
{| border="1" cellpadding="2" cellspacing="0"
|-
|[[83Plus:Software:usb8x/Asm_Interface/AutoSetup|AutoSetup]] || Automatically sets up USB device
|-
|[[83Plus:Software:usb8x/Asm_Interface/ConfigureDevice|ConfigureDevice]] || Chooses a device configuration
|-
|[[83Plus:Software:usb8x/Asm_Interface/FindDescriptor|FindDescriptor]] || Finds a specific descriptor in a list
|-
|[[83Plus:Software:usb8x/Asm_Interface/FindPipe|FindPipe]] || Finds a pipe matching characteristics
|-
|[[83Plus:Software:usb8x/Asm_Interface/GetClass|GetClass]] || Returns the class and subclass for the current device
|-
|[[83Plus:Software:usb8x/Asm_Interface/GetIDs|GetIDs]] || Returns product and vender IDs for current device
|-
|[[83Plus:Software:usb8x/Asm_Interface/HostInit|HostInit]] || Initialize a USB device
|-
|[[83Plus:Software:usb8x/Asm_Interface/InternalInfo|InternalInfo]] || Returns current internal usb8x settings
|-
|[[83Plus:Software:usb8x/Asm_Interface/LogCustom|LogCustom]] || Adds an entry to current log file
|-
|[[83Plus:Software:usb8x/Asm_Interface/PipeInfo|PipeInfo]] || Gets direction, type, and packet size for a pipe
|-
|[[83Plus:Software:usb8x/Asm_Interface/Pump|Pump]] || Should be called periodically when pump mode is on to poll USB port
|-
|[[83Plus:Software:usb8x/Asm_Interface/PumpOff|PumpOff]] || Turns off pump mode
|-
|[[83Plus:Software:usb8x/Asm_Interface/PumpOn|PumpOn]] || Turns on pump mode so that usb8x can be used with TIOS interrupt disabled
|-
|[[83Plus:Software:usb8x/Asm_Interface/ReadDescriptor|ReadDescriptor]] || Reads a descriptor from the device
|-
|[[83Plus:Software:usb8x/Asm_Interface/ReqData|ReqData]] || Request data from an incoming pipe
|-
|[[83Plus:Software:usb8x/Asm_Interface/SendControlData|SendControlData]] || Sends data to the control pipe
|-
|[[83Plus:Software:usb8x/Asm_Interface/SendControlDataOut|SendControlDataOut]] || Sends data to the control pipe with an out data stage
|-
|[[83Plus:Software:usb8x/Asm_Interface/SendData|SendData]] || Send data to the device
|-
|[[83Plus:Software:usb8x/Asm_Interface/SetCallBack|SetCallBack]] || Sets the current callback routine
|-
|[[83Plus:Software:usb8x/Asm_Interface/SetupInPipe|SetupInPipe]] || Sets up an incoming pipe
|-
|[[83Plus:Software:usb8x/Asm_Interface/SetupLog|SetupLog]] || Starts logger
|-
|[[83Plus:Software:usb8x/Asm_Interface/SetupOutPipe|SetupOutPipe]] || Sets up an outgoing pipe
|-
|[[83Plus:Software:usb8x/Asm_Interface/StopLog|StopLog]] || Stops logger
|-
|[[83Plus:Software:usb8x/Asm_Interface/WaitTimerB|WaitTimerB]] || Precise delay
|}