Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

smb(4) [netbsd man page]

SMB(4)							   BSD Kernel Interfaces Manual 						    SMB(4)

NAME
smb -- SMB generic I/O device driver SYNOPSIS
device smb DESCRIPTION
The smb character device driver provides generic i/o to any smbus(4) instance. In order to control SMB devices, use /dev/smb? with the ioctls described below. Any of these ioctl commands takes a pointer to struct smbcmd as its argument. #include <sys/types.h> struct smbcmd { char cmd; int count; u_char slave; union { char byte; short word; char *byte_ptr; short *word_ptr; struct { short sdata; short *rdata; } process; } data; }; The slave field is always used, and provides the address of the SMBus slave device to talk to. The slave address is specified in the seven most significant bits (i.e. ``left-justified''). The least significant bit of the slave address must be zero. Ioctl Description SMB_QUICK_WRITE The QuickWrite command just issues the device address with write intent to the bus, without transferring any data. SMB_QUICK_READ The QuickRead command just issues the device address with read intent to the bus, without transferring any data. SMB_SENDB The SendByte command sends the byte provided in the cmd field to the device. SMB_RECVB The ReceiveByte command reads a single byte from the device which will be returned in the cmd field. SMB_WRITEB The WriteByte command first sends the byte from the cmd field to the device, followed by the byte given in data.byte. SMB_WRITEW The WriteWord command first sends the byte from the cmd field to the device, followed by the word given in data.word. Note that the SMBus byte-order is little-endian by definition. SMB_READB The ReadByte command first sends the byte from the cmd field to the device, and then reads one byte of data from the device. The returned data will be stored in the location pointed to by data.byte_ptr. SMB_READW The ReadWord command first sends the byte from the cmd field to the device, and then reads one word of data from the device. The returned data will be stored in the location pointed to by data.word_ptr. SMB_PCALL The ProcedureCall command first sends the byte from the cmd field to the device, followed by the word provided in data.process.sdata. It then reads one word of data from the device, and returns it in the location pointed to by data.process.rdata. SMB_BWRITE The BlockWrite command first sends the byte from the cmd field to the device, followed by count bytes of data that are taken from the buffer pointed to by data.byte_ptr. The SMBus specification mandates that no more than 32 bytes of data can be transferred in a single block read or write command. This value is available in the constant SMB_MAXBLOCKSIZE. SMB_BREAD The BlockRead command first sends the byte from the cmd field to the device, and then reads count bytes of data that from the device. These data will be returned in the buffer pointed to by data.byte_ptr. The read(2) and write(2) system calls are not implemented by this driver. ERRORS
The ioctl(2) commands can cause the following driver-specific errors: [ENXIO] Device did not respond to selection. [EBUSY] Device still in use. [ENODEV] Operation not supported by device (not supposed to happen). [EINVAL] General argument error. [EWOULDBLOCK] SMBus transaction timed out. SEE ALSO
ioctl(2), smbus(4) HISTORY
The smb manual page first appeared in FreeBSD 3.0. AUTHORS
This manual page was written by Nicolas Souchu. BSD
February 6, 2009 BSD

Check Out this Related Man Page

PTS(4)							   BSD Kernel Interfaces Manual 						    PTS(4)

NAME
pts -- pseudo-terminal driver DESCRIPTION
The pts driver provides support for a device-pair termed a pseudo-terminal. A pseudo-terminal is a pair of character devices, a master device and a slave device. The slave device provides to a process an interface identical to that described in tty(4). However, whereas all other devices which provide the interface described in tty(4) have a hardware device of some sort behind them, the slave device has, instead, another process manipulating it through the master half of the pseudo-terminal. That is, anything written on the master device is given to the slave device as input and anything written on the slave device is presented as input on the master device. The following ioctl(2) calls apply only to pseudo-terminals: TIOCPKT Enable/disable packet mode. Packet mode is enabled by specifying (by reference) a nonzero parameter and disabled by specifying (by reference) a zero parameter. When applied to the master side of a pseudo-terminal, each subsequent read(2) from the termi- nal will return data written on the slave part of the pseudo-terminal preceded by a zero byte (symbolically defined as TIOCPKT_DATA), or a single byte reflecting control status information. In the latter case, the byte is an inclusive-or of zero or more of the bits: TIOCPKT_FLUSHREAD whenever the read queue for the terminal is flushed. TIOCPKT_FLUSHWRITE whenever the write queue for the terminal is flushed. TIOCPKT_STOP whenever output to the terminal is stopped a la '^S'. TIOCPKT_START whenever output to the terminal is restarted. TIOCPKT_DOSTOP whenever VSTOP is '^S' and VSTART is '^Q'. TIOCPKT_NOSTOP whenever the start and stop characters are not '^S/^Q'. While this mode is in use, the presence of control status information to be read from the master side may be detected by a select(2) for exceptional conditions. This mode is used by rlogin(1) and rlogind(8) to implement a remote-echoed, locally '^S/^Q' flow-controlled remote login with proper back-flushing of output; it can be used by other similar programs. TIOCGPTN Obtain device unit number, which can be used to generate the filename of the pseudo-terminal slave device. This ioctl(2) should not be used directly. Instead, the ptsname(3) function should be used. TIOCPTMASTER Determine whether the file descriptor is pointing to a pseudo-terminal master device. This ioctl(2) should not be used directly. It is used to implement routines like grantpt(3). FILES
The files used by this pseudo-terminals implementation are: /dev/pts/[num] Pseudo-terminal slave devices. DIAGNOSTICS
None. SEE ALSO
posix_openpt(2), grantpt(3), ptsname(3), pty(4), tty(4) HISTORY
A pseudo-terminal driver appeared in 4.2BSD. In FreeBSD 8.0, it was replaced with the pts driver. BSD
August 20, 2008 BSD
Man Page