PortableT30 is a fax protocol state machine portable across a number of operating systems and hardware platforms. In order to achieve portability PortableT30 isolates system dependencies to “adaptation” packages. The process of porting T.30, then, requires the rewrite of the adaptation packages, not T.30.
This design partitioning has resulted in the following major components:
- T.30 Core consisting of the T.30 state machine and HDLC support routines.
- Event Preprocessor converts system events into T.30 Core events.
- Hardware Adaptation consisting of routines for interfacing with the modems, including V.34.
- Timer Package provides timer service to the T.30 Core.
- Image Data Service handles image data and conversions on-line.
- Image I/O Service handles physical I/O of the image data.
- API Package provides an interface for the controlling application.
- Buffer Management Package manages a pool of image-data buffers.
- Parameter Manager provides access to system parameters by name.
The T.30 core consists of a finite state machine driven by events from the Event Preprocessor. The finite state machine implements all sections and protocols of the ITU T.30 specification. It makes use of the other services to implement the processing required by each event transition.
PortableT30 maintains a context area for each separate T.30 session it is handling. This context is initialized when the application requests service and remains in existence until the application specifically terminates the session, giving Portable T30 an inherent multi-channel capability.
The Event Preprocessor controls the operation of the T.30 Core. It accepts or detects event conditions in the environment, converts these conditions into events for the T.30 core, and passes the event, along with the appropriate channel context, to the T.30 Core for processing.
The exact nature of the Event Preprocessor depends on the operating system used. Under NT it may run as a separate thread for each session. The input of un-processed events to this package depends on the hardware adaptation required and operating system services available.
The Hardware Adaptation layer presents a set of basic functions to PortableT30 for controlling modem operation. There are a number of models available for this interface. Some of the design issues are:
- Mini-Sequences – Because timing required by T.30 between modem operations, some fax command sequences must be performed as one command if the system partitioning has the T.30 engine executing on a processor with significant command latency.
- Fixed-Length Buffering – Some environments require a relatively large buffer for data transfer between the controlling environment and the modems, sometimes placing unique requirements on the formatting of data and the design of the modems.
The Timer Package implements timer-based events to trigger error recovery for T.30. A number of timers are specified in T.30, and in some cases the protocol depends on the expiration of a timer to move to a new state. The actual implementation of the times is operating-system and hardware dependent. In some cases, the hardware platform can generate timer events that can be routed through the Event Preprocessor to drive the Timer Package, in others the operating system provides sufficient facilities.
Timers for T.30 support require a resolution of no more than one-half-second accuracy. The longest timer required is 30 seconds.
Image Data Service
The Image Data Service is responsible for handling data between external storage and PortableT30. It handles all format conversions. BFT, ECM and MMR are treated as additional conversion formats.
The Image Data Service treats image data as a sequence of documents each consisting of a series of pages. T.30 will renegotiate between documents in order to transfer new NSF information and possibly to change document size, etc. In the case of BFT and ECM a page is a single high-speed modem operation rather than an actual page. The Image Data Service separates the physical storage interface from the image-formatting function, permitting the use of alternative file formats and data sources other than disk files to be used for supplying/receiving data.
Image I/O Service
The Image I/O Service handles the physical I/O of the image data. Some implementations use the “C” runtime library to access TIFF-F-formatted files. Other implementations may uset other image data containers or network-based file storage.
The API Package is divided into front-end and back-end sections. The front-end section collects the parameters required for each call and packs the parameters into a datagram. The datagrams are routed to the back-end portion. The back-end portion unpacks the parameters and issues the call to Portable T30 by configuring the context area and generating events.
The front end of the API is linked to the application. The back end is linked with PortableT30. The application and Portable T30 might execute on different nodes on a network. Another form would place the application and API front end on the host and the portableT30 and back end on the scalar processor on a hardware board.
Buffer Management Package
T.30 requires a number of large buffers for image data. In PortableT30 the facility filling a buffer creates the buffer to pass to T.30. It is the responsibility of PortableT30 to call the appropriate release function when use of the buffer is complete. For example, in transmit, T.30 requests a buffer of data from Image Data Services. Image Data Services allocates a buffer, fills it with data and returns a pointer to the buffer to T.30. T.30 passes the buffer unchanged to the Hardware Adaptation Layer for queuing to the modem resource. Once the data have been passed to the modem resource, the Hardware Adaptation Layer releases the buffer to Buffer Management. The hardware Adaptation Layer will allocate and queue buffers to the modem resource as required. Each time a buffer is filled, T.30 will be notified by event. It will request a pointer to the filled buffer from the Hardware Adaptation Layer. This buffer is passed to Image Data Services for processing. The buffer is returned to buffer poll by Image Data Services.
This package allocates a number of buffers as required by the implementations of the Hardware Adaptation Layer and the Image Data Services. The size of these buffers is dependent on the buffering restrictions for the modem resource.
Portable T30 makes use of a number of system configuration parameters. It would be cumbersome to specify all parameters with each call. Also various versions of PortableT30 require special configuration parameters, this facility provides the adaptation layers with an interface to read version-specific parameters without changes to the application or other components of PortableT30.
FSM Design Tool
A Finite State Machine (FSM) is a state machine that is composed of a finite number of states and events. A state machine is a set of tuples, with each tuple composed of an old state, event, new state, and action. Commetrex has developed a design tool to support the creation of complex FSMs which defines the FSM in an SQL database. Each record in the database documents a tuple, defining the action to be taken when the machine is in the old state and the event is detected. The tuple record lists the new state the machine assumes and the action it performs. The actions are defined in the tuple by the associated module name. The design tool is used to create a database of these tuples and translate the data base into C code.
The FSM Design Tool is a GUI-based program designed to allow simple and intuitive development, viewing, and modification of any FSM. This tool is designed to be the only interface necessary for design and maintenance of the FSM. The developer has the option of quickly and easily navigating the FSM, the same way a program would, by using events to jump from state to state, or to navigate sequentially through the database table. The FSM Design Tool flexibly handles database access, version control issues, and the spawning of the user’s desired editor program.
The FSM database contains five tables, each consisting of several fields (see below). Two of the tables have a unique index, or key, defined to ensure that there are no duplicate records as well as to facilitate the querying of information from the database. Only the MODULE table and the FSM table are modified through the FSM Design Tool. The STATES, EVENTS, and VARIANTS tables are used to populate the selection lists for associated fields. These are static tables created at installation time.