usr.sbin/pccard/pccardd/pccardd.8

   1 .\"
   2 .\" Copyright (c) 1994 Andrew McRae.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. The name of the author may not be used to endorse or promote products
  13 .\"    derived from this software without specific prior written permission.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/usr.sbin/pccard/pccardd/pccardd.8,v 1.17.2.7 2001/08/16 15:56:12 ru Exp $
  27 .\" $DragonFly: src/usr.sbin/pccard/pccardd/Attic/pccardd.8,v 1.2 2003/06/17 04:29:59 dillon Exp $
  28 .\"
  29 .Dd November 1, 1994
  30 .Dt PCCARDD 8
  31 .Os
  32 .Sh NAME
  33 .Nm pccardd
  34 .Nd PC-CARD (PCMCIA) management daemon
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Op Fl d
  38 .Op Fl v
  39 .Op Fl z
  40 .Op Fl i Ar IRQ
  41 .Op Fl I
  42 .Op Fl f Ar configfile
  43 .Sh DESCRIPTION
  44 .Nm Pccardd
  45 is normally started at boot time, and manages the insertion
  46 and removal of PC-CARD cards.
  47 .Pp
  48 When started,
  49 .Nm
  50 will read the configuration file (default name
  51 .Pa /etc/defaults/pccard.conf
  52 which includes
  53 .Pa /etc/pccard.conf
  54 as the user configuration file)
  55 and scans the available PC-CARD slots for cards.
  56 .Nm Pccardd
  57 then waits for
  58 .Em "card events" ,
  59 such as the insertion of a new card or the removal
  60 of a card.
  61 .Pp
  62 When a card is inserted, the following
  63 actions are taken:
  64 .Bl -enum
  65 .It
  66 The kernel driver detects the card insertion and applies
  67 power to the card.
  68 .It
  69 .Nm Pccardd
  70 reads the
  71 .Em CIS
  72 data from the attribute memory of the card, and uses
  73 the manufacturer name and card version to match
  74 the card description in the configuration file.
  75 .It
  76 Once matched, a driver is allocated.
  77 .It
  78 Once a free driver and device instance is located,
  79 .Nm
  80 will (if required) allocate resources such as an ISA memory
  81 block and Input/Output ports from a common pool.
  82 .It
  83 The PC-CARD slot is configured with the I/O and memory
  84 contexts allocated, and the kernel driver is attached to
  85 this card.
  86 .It
  87 If the attach succeeds, then specific shell commands
  88 may be executed to configure the device, such as
  89 .Xr ifconfig 8
  90 to set up a network interface.
  91 Separate commands may be specified
  92 for each card, driver or device, and are executed in that order.
  93 .El
  94 .Pp
  95 When
  96 .Nm
  97 detects that a card has been removed, the following sequence occurs:
  98 .Bl -enum
  99 .It
 100 The shell commands associated with card removal are executed.
 101 These
 102 are intended to reset any device associated with the removed card.
 103 Separate commands may exist for card, driver and device instances.
 104 .It
 105 The PC-CARD slot resources are freed.
 106 .El
 107 .Pp
 108 Once a card/driver instance is configured, the resources
 109 bound to that instance are remembered, and if the card is removed
 110 and reinserted, the same driver is allocated.
 111 The primary reason
 112 is that once a driver is associated with a card, the
 113 driver's
 114 .Fn probe
 115 routine has been called, and this usually causes driver specific
 116 data areas to be initialized with the I/O ports or memory resources
 117 allocated to the card.
 118 Most drivers are not designed to be
 119 disassociated from the hardware and then reassociated with different
 120 parameters.
 121 This will change significantly when loadable kernel
 122 modules are supported.
 123 .Pp
 124 SIGHUP causes
 125 .Nm
 126 to reload the configuration files.
 127 .Pp
 128 The start options understood by
 129 .Nm
 130 are:
 131 .Bl -tag -width Ds
 132 .It Fl d
 133 Do not run as a daemon, but run in the foreground and
 134 display error messages.
 135 .It Fl v
 136 After reading the configuration file, print out a summary
 137 of it.
 138 .It Fl z
 139 Delays running as a daemon until after the cards have been probed and attached.
 140 .It Fl I
 141 Don't get a list of free IRQs from kernel.
 142 .It Fl i Ar IRQ
 143 Configures an available IRQ.  It overrides the "irq" line in
 144 .Pa /etc/defaults/pccard.conf
 145 and
 146 .Pa /etc/pccard.conf .
 147 .It Fl f Ar configfile
 148 Specifies a different configuration file to be used
 149 in placed of the default file
 150 .Pa /etc/defaults/pccard.conf .
 151 The file format is detailed in
 152 .Xr pccard.conf 5 ,
 153 and lists the PC-CARD cards recognized by
 154 .Nm ,
 155 and the kernel drivers and devices that are used to
 156 interface to the card.
 157 .El
 158 .Sh FILES
 159 .Bl -tag -width /etc/defaults/pccard.conf -compact
 160 .It Pa /etc/defaults/pccard.conf
 161 default configuration file
 162 .It Pa /etc/pccard.conf
 163 user configuration file
 164 .It Pa /var/run/pccardd.pid
 165 process id of the currently running
 166 .Nm
 167 .El
 168 .Sh SEE ALSO
 169 .Xr pccard.conf 5 ,
 170 .Xr ifconfig 8
 171 .Sh AUTHORS
 172 Developed by
 173 .An Andrew McRae Aq andrew@mega.com.au .
 174 .Sh BUGS
 175 .Nm Pccardd
 176 can set up card parameters, but cannot guarantee that
 177 particular drivers can work with the card.
 178 .Pp
 179 Removing cards may cause problems if system resources
 180 have been associated with the card, such as network
 181 mounted filesystems.