Kernel Functions for Drivers csxGetFirstTuple(9F)
NAME
csxGetFirstTuple, csxGetNextTuple - return Card Informa-
tion Structure tuple
SYNOPSIS
#include
int32t csxGetFirstTuple(clienthandlet ch, tuplet *tu);
int32t csxGetNextTuple(clienthandlet ch, tuplet *tu);
INTERFACE LEVEL
Solaris DI Specific (Solaris DI)
PARAMETERS
ch Client handle returned from csxRegisterClient(9F).
tu Pointer to a tuplet structure.
DESCRIPTION
The functions csxGetFirstTuple() and csxGetNextTuple()
return the first and next tuple, respectively, of the speci-
fied type in the Card Information Structure (CIS) for the
specified socket.
STRUCTURE MEMBERS
The structure members of tuplet are:
uint32t Socket; /* socket number */
uint32t Attributes; /* Attributes */
cisdatat DesiredTuple; /* tuple to search for or flags */
cisdatat TupleCode; /* tuple type code */
cisdatat TupleLink; /* tuple data body size */
The fields are defined as follows:
Socket Not used in Solaris, but for porta-
bility with other Card Services
implementations, it should be set to
the logical socket number.
Attributes This field is bit-mapped. The follow-
ing bits are defined:
SunOS 5.11 Last change: 20 Dec 1996 1
Kernel Functions for Drivers csxGetFirstTuple(9F)
TUPLERETURNLINK
Return link tuples if set. The
following are link tuples and
will only be returned by this
function if the TUPLERETURNLINK
bit in the Attributes field is
set:
CISTPLNUL CISTPLONGLINKMFC
CISTPLONGLINKA CISTPLINKTARGET
CISTPLONGLINKC CISTPLNOLINK
CISTPLONGLINKCB CISTPLEND
TUPLERETURNIGNOREDTUPLES
Return ignored tuples if set.
Ignored tuples will be returned
by this function if the
TUPLERETURNIGNOREDTUPLES bit
in the Attributes field is set,
see tuple(9S) for more informa-
tion. The CIS is parsed from the
location setup by the previous
csxGetFirstTuple() or
csxGetNextTuple() request.
DesiredTuple This field is the tuple value
desired. If it is RETURNFIRSTUPLE,
the very first tuple of the CIS is
returned (if it exists). If this
field is set to RETURNEXTUPLE,
the very next tuple of the CIS is
returned (if it exists). If the
DesiredTuple field is any other value
on entry, the CIS is searched in an
attempt to locate a tuple which
matches.
TupleCode,TupleLink These fields are the values returned
from the tuple found. If there are no
tuples on the card, CSNOMOREITEMS
is returned.
SunOS 5.11 Last change: 20 Dec 1996 2
Kernel Functions for Drivers csxGetFirstTuple(9F)
Since the csxGetFirstTuple(), csxGetNextTuple(), and
csxGetTupleData(9F) functions all share the same tuplet
structure, some fields in the tuplet structure are unused
or reserved when calling this function and these fields must
not be initialized by the client.
RETURN VALUES
CSUCES Successful operation.
CSBADHANDLE Client handle is invalid.
CSNOCARD No PC Card in socket.
CSNOCIS No Card Information Structure
(CIS) on PC card.
CSNOMOREITEMS Desired tuple not found.
CSUNSUPORTEDFUNCTION No PCMCIA hardware installed.
CONTEXT
These functions may be called from user or kernel context.
SEE ALSO
csxGetTupleData(9F), csxParseTuple(9F),
csxRegisterClient(9F), csxValidateCIS(9F), tuple(9S)
PC Card 95Standard, PCMCIA/JEIDA
SunOS 5.11 Last change: 20 Dec 1996 3
|