SVR5 and SCO OpenServer 5

Intro(D3pccard)

Intro -- introduction to PC Card client service function calls

Synopsis

   #include <sys/lcs.h>
   #include <sys/lss.h>

Functional notation for CardServices call (SVR5)

   int Cardservices(int Service, void *Handle, void *Pointer,
    		 void *ArgLength, void *ArgPointer, rm_key_t rmkey);

Functional notation for CardServices call (SCO OpenServer 5)

   int Cardservices(int Service, void *Handle, void *Pointer,
    		 void *ArgLength, void *ArgPointer);

Description

This section documents the SCO implementation of the CardServices( ) services that are defined in the Personal Computer Memory Card International Association (PCMCIA) standard. These services allocate and manage system resources by parsing CIS tuples, requesting IRQs and memory windows, and other similar tasks. The client-enabled device driver must interface properly with the CardServices( ) routine and the documented services.

The SCO implementation uses the sixty services that are defined in the standard. For the SVR5 implementation, a sixth parameter, rmkey, is added to the standard syntax to interface with the SVR5 resource manager database; see ``Resource manager database'' in HDK Technical Reference. The SCO OpenServer 5 syntax matches that defined in the standard.

The SCO implementation defines UNIX style structures to contain much of the information that the standard defines for each service. These structures are documented in the Section D4pccard manual pages in Section D4pccard manual pages.

Return values

All of the functions called in the SCO implementation return a value, which is always an ineger. See the individual manual pages for the specific return values for each service and the return_codes(D5pccard) manual page for a complete list of supported return codes.

Usage

The PCMCIA Cardservices Specification carries the C language concept of an overloaded function to the extreme, calling all sixty functions by the name ``CardServices''. The functions differ in parameters passed but there are always the same number of parameters.

The following example illustrates how the CardServices( ) services are called in a SVR5 client-enabled device driver:

    i = CardServices(GetTupleData, NULL, NULL,
                    sizeof ( Tuple_t ), &tuple, rmkey);

The call in an SCO OpenServer 5 driver is the same except that the rmkey parameter is omitted.

In the above example:

GetTupleData: is the particular card service requested.
NULLs: indicate that the generic Handle and Pointer are not relevant to a GetTupleData function call. (Some other functions require a Cardservices Handle to identify some resource. Some require a Pointer value to pass a pointer other than ArgPointer.)
ArgLength: is the size of the variable Tuple_t, in bytes. ArgLength more generally is the representation of the size of the buffer pointed to by ArgPointer.
ArgPointer: is the address of the variable tuple, and is the beginning address of the buffer.
rmkey: is the resource manager key of the physical device driver which the kernel passes to the CFG_ADD subroutine of the config(D2pccard) entry point routine. See ``Resource manager database'' in HDK Technical Reference.
This argument is not part of the standard and is used only for SVR5 PC Card drivers, not for SCO OpenServer 5 drivers.

Context and synchronization

See the individual manual pages for information about the context of each service. This information determines the entry points from which each service can be called; see ``Context of a driver'' in HDK Technical Reference.

Version applicability

The version applicability information provided on the individual manual pages defines the versions in which each service can be used:

pccard: 1: SCO OpenServer 5 version; not implemented at the current time. When implemented, will require ODDI verstion 5 or later.
pccard: 2: SVR5 version; the current implementation requires DDI version 7.2, but future implemenations will support DDI version 8 and later.
pccard: 3: Contains services that are defined in the standard but not yet implemented and tested for SCO platforms. Future SCO implementations may support these services.

References

Developing PC Card drivers in Developing PC Card drivers
``PC Card interface (PCMCIA)'' in HDK Technical Reference

A client-enabled PCCARD driver is coded using:

Section D2pccard manual pages in Section D2pccard manual pages for the entry point routines.
Section D3pccard manual pages in Section D3pccard manual pages for the CardServices( ) services.
Section D4pccard manual pages in Section D4pccard manual pages for structures that are used with the CardServices( ) services.
Section D5pccard manual pages in Section D5pccard manual pages for the event codes and return codes that are used for client-enabled driver functionality.

PCCARD drivers use the standard DDI or ODDI entry points, functions, strutures, and defines for the I/O operations that their driver supports:

Section D2 manual pages in Section D2 manual pages, Section D3 manual pages in Section D3 manual pages, Section D4 manual pages in Section D4 manual pages, and Section D5 manual pages in Section D5 manual pages for SVR5 DDI drivers.
Section D2oddi manual pages in Section D2oddi manual pages, Section D3oddi manual pages in Section D3oddi manual pages, and Section D4oddi manual pages in Section D4oddi manual pages for SCO OpenServer 5 ODDI kernel drivers.
Section D2mdi manual pages in Section D2mdi manual pages, Section D3mdi manual pages in Section D3mdi manual pages, Section D4mdi manual pages in Section D4mdi manual pages, Section D7mdi manual pages in Section D7mdi manual pages, and Section 7mdi manual pages in Section 7mdi manual pages for SVR5 and SCO OpenServer 5 MDI network drivers.
Section D2sdi manual pages in Section D2sdi manual pages, Section D3sdi manual pages in Section D3sdi manual pages, Section D4sdi manual pages in Section D4sdi manual pages, and Section D5sdi manual pages in Section D5sdi manual pages for SVR5 SDI mass storage drivers.
Section D2osdi manual pages in Section D2osdi manual pages, Section D3osdi manual pages in Section D3osdi manual pages, and Section D4osdi manual pages in Section D4osdi manual pages for SCO OpenServer 5 OSDI mass storage drivers.