share/man/man4/smb.4

   1 .\" Copyright (c) 1998, Nicolas Souchu
   2 .\" 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 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD: src/share/man/man4/smb.4,v 1.6.2.2 2001/08/17 13:08:39 ru Exp $
  26 .\" $DragonFly: src/share/man/man4/smb.4,v 1.2 2003/06/17 04:36:59 dillon Exp $
  27 .\"
  28 .Dd October 25, 1998
  29 .Dt SMB 4
  30 .Os
  31 .Sh NAME
  32 .Nm smb
  33 .Nd SMB generic I/O device driver
  34 .Sh SYNOPSIS
  35 .Cd "device smb"
  36 .Sh DESCRIPTION
  37 The
  38 .Em smb
  39 character device driver provides generic i/o to any
  40 .Xr smbus 4
  41 instance.
  42 In order to control SMB devices, use /dev/smb? with the
  43 following ioctls:
  44 .Pp
  45 .Bl -column "System Management Bus ioctls" -compact
  46 .It Em Ioctl Ta Em Description
  47 .It Sy SMB_QUICK_WRITE Ta "QuickWrite command"
  48 .It Sy SMB_QUICK_READ Ta "QuickRead command"
  49 .It Sy SMB_SENDB Ta "SendByte command"
  50 .It Sy SMB_RECVB Ta "ReceiveByte command"
  51 .It Sy SMB_WRITEB Ta "WriteByte command"
  52 .It Sy SMB_WRITEW Ta "WriteWord command"
  53 .It Sy SMB_READB Ta "ReadByte command"
  54 .It Sy SMB_READW Ta "ReadWord command"
  55 .It Sy SMB_PCALL Ta "ProcedureCall command"
  56 .It Sy SMB_BWRITE Ta "BlockWrite command"
  57 .It Sy SMB_BREAD Ta "BlockRead command"
  58 .El
  59 .Pp
  60 Using the write routine is equivalent to a SMB_WRITEW ioctl.
  61 .Sh SEE ALSO
  62 .Xr smbus 4
  63 .Sh HISTORY
  64 The
  65 .Nm
  66 manual page first appeared in
  67 .Fx 3.0 .
  68 .Sh AUTHORS
  69 This
  70 manual page was written by
  71 .An Nicolas Souchu .