manual/pcmcia-cs/draft/man4/dummy_cs.4

   1 .\" Copyright (C) 1998 David A. Hinds -- dhinds@pcmcia.sourceforge.org
   2 .\" dummy_cs.4 1.6 1999/10/25 19:50:45
   3 .\"
   4 .\"O .TH DUMMY_CS 4 "1999/10/25 19:50:45" "pcmcia-cs"
   5 .\"O .SH NAME
   6 .\"O dummy_cs \- PCMCIA dummy device driver
   7 .\"O .SH SYNOPSIS
   8 .\"O .B insmod dummy_cs.o
   9 .\"O .RB [ pc_debug=\c
  10 .\"O .IR n ]
  11 .\"O .RB [ free_ports=\c
  12 .\"O .IR n ]
  13 .\"O .RB [ irq_list=\c
  14 .\"O .IR i,j,... ]
  15 .\"O .SH DESCRIPTION
  16 .\"O The
  17 .\"O .B dummy_cs
  18 .\"O module has two purposes.  It is intended as a demonstration of how to
  19 .\"O write the PCMCIA interface code for a client driver, and the source
  20 .\"O code is heavily commented.  It is also written to function as a sort
  21 .\"O of generic ``point enabler'': when bound to any PCMCIA IO card, it
  22 .\"O will read the card's Configuration Information Structure, and
  23 .\"O configure the card appropriately.  The configuration includes setting
  24 .\"O up IO and memory windows, configuring the card for interrupts, and
  25 .\"O initializing the card's PCMCIA configuration registers.
  26 .\"O .PP
  27 .\"O It turns out that many cards report incomplete or inaccurate
  28 .\"O configuration information, due to vendor carelessness and the
  29 .\"O complexity of the data format.  A vendor driver can generally take
  30 .\"O for granted many configuration details, so there is not much incentive
  31 .\"O for vendors to ensure that the on-card information is complete.  Thus,
  32 .\"O the
  33 .\"O .B dummy_cs
  34 .\"O module is limited by its generality: since it makes no assumptions
  35 .\"O about card types, it is forced to rely on the card information, for
  36 .\"O better or worse.
  37 .\"O .SH PARAMETERS
  38 .\"O .TP
  39 .\"O .BI pc_debug= n
  40 .\"O Selects the PCMCIA debugging level.  This parameter is only available
  41 .\"O if the module is compiled with debugging enabled.  A non-zero value
  42 .\"O enables debugging.
  43 .\"O .TP
  44 .\"O .BI free_ports= n
  45 .\"O A flag indicating if the IO ports allocated for the card should be
  46 .\"O freed from the kernel resource maps.  This is useful if the dummy
  47 .\"O driver is being used to configure a card in preparation for loading a
  48 .\"O specific PCMCIA-unaware driver.  The default is 0 (false).
  49 .\"O .TP
  50 .\"O .BI irq_list= i,j,...
  51 .\"O Specifies the set of interrupts that may be allocated by this driver.
  52 .\"O .SH AUTHOR
  53 .\"O David Hinds \- dhinds@pcmcia.sourceforge.org
  54 .\"O .SH "SEE ALSO"
  55 .\"O cardmgr(8), pcmcia(5).