Tribblix: manual page: csx_AccessConfigurationRegister.9f

CSX_ACCESSCONFIGURATIONREGISTER(9F) Kernel Functions for Drivers

NAME

csx_AccessConfigurationRegister - read or write a PC Card
Configuration Register

SYNOPSIS

#include <sys/pccard.h>

int32_t csx_AccessConfigurationRegister(client_handle_t ch,
access_config_reg_t *acr);

INTERFACE LEVEL

illumos DDI Specific (illumos DDI)

PARAMETERS

ch
Client handle returned from csx_RegisterClient(9F).

acr
Pointer to an access_config_reg_t structure.

DESCRIPTION

This function allows a client to read or write a PCCard Configuration
Register.

STRUCTURE MEMBERS

The structure members of access_config_reg_t are:

uint32_t Socket; /* socket number*/
uint32_t Action; /* register access operation*/
uint32_t Offset; /* config register offset*/
uint32_t Value; /* value read or written*/

The fields are defined as follows:

Socket
Not used in illumos, but for portability with other Card
Services implementations, it should be set to the logical
socket number.

Action
May be set to CONFIG_REG_READ or CONFIG_REG_WRITE. All
other values in the Action field are reserved for future
use. If the Action field is set to CONFIG_REG_WRITE, the
Value field is written to the specified configuration
register. Card Services does not read the configuration
register after a write operation. For that reason, the
Value field is only updated by a CONFIG_REG_READ request.

Offset
Specifies the byte offset for the desired configuration
register from the PC Card configuration register base
specified in csx_RequestConfiguration(9F).

Value
Contains the value read from the PC Card Configuration
Register for a read operation. For a write operation, the
Value field contains the value to write to the
configuration register. As noted above, on return from a
write request, the Value field is the value written to the
PC Card and not any changed value that may have resulted
from the write request (that is, no read after write is
performed).

A client must be very careful when writing to the COR (Configuration
Option Register) at offset 0. This has the potential to change the
type of interrupt request generated by the PC Card or place the card
in the reset state. Either request may have undefined results. The
client should read the register to determine the appropriate setting
for the interrupt mode (Bit 6) before writing to the register.

If a client wants to reset a PCCard, the csx_ResetFunction(9F)
function should be used. Unlike csx_AccessConfigurationRegister(),
the csx_ResetFunction(9F) function generates a series of event
notifications to all clients using the PC Card, so they can re-
establish the appropriate card state after the reset operation is
complete.

RETURN VALUES

CS_SUCCESS
Successful operation.

CS_BAD_ARGS
Specified arguments are invalid. Client
specifies an Offset that is out of range
or neither CONFIG_REG_READ or
CONFIG_REG_WRITE is set.

CS_UNSUPPORTED_MODE
Client has not called
csx_RequestConfiguration(9F) before
calling this function.

CS_BAD_HANDLE
Client handle is invalid.

CS_NO_CARD
No PC card in socket.

CS_UNSUPPORTED_FUNCTION
No PCMCIA hardware installed.

CONTEXT

This function may be called from user or kernel context.