diff options
| -rw-r--r-- | share/man/man4/Makefile | 4 | ||||
| -rw-r--r-- | share/man/man4/man4.i386/Makefile | 6 | ||||
| -rw-r--r-- | share/man/man4/man4.i386/az.4 | 55 | ||||
| -rw-r--r-- | share/man/man4/man4.i386/sf2r.4 | 54 | ||||
| -rw-r--r-- | share/man/man4/man4.i386/sf4r.4 | 50 | ||||
| -rw-r--r-- | share/man/man4/radio.4 | 130 | ||||
| -rw-r--r-- | share/man/man9/Makefile | 4 | ||||
| -rw-r--r-- | share/man/man9/radio.9 | 93 |
8 files changed, 389 insertions, 7 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile index fadcca20cc9..a1829825488 100644 --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -1,4 +1,4 @@ -# $OpenBSD: Makefile,v 1.177 2001/10/02 03:45:10 millert Exp $ +# $OpenBSD: Makefile,v 1.178 2001/10/04 22:33:49 gluk Exp $ MAN= aac.4 ac97.4 addcom.4 adv.4 aha.4 ahb.4 ahc.4 aic.4 ami.4 amphy.4 \ an.4 aria.4 ast.4 \ @@ -19,7 +19,7 @@ MAN= aac.4 ac97.4 addcom.4 adv.4 aha.4 ahb.4 ahc.4 aic.4 ami.4 amphy.4 \ nsphy.4 nsphyter.4 \ null.4 ohci.4 opl.4 options.4 pcdisplay.4 pchb.4 pckbc.4 pckbd.4 \ pci.4 pciide.4 pcmcia.4 pcscp.4 pf.4 pms.4 \ - pty.4 puc.4 qsphy.4 raid.4 random.4 ray.4 rd.4 rl.4 rln.4 \ + pty.4 puc.4 qsphy.4 radio.4 raid.4 random.4 ray.4 rd.4 rl.4 rln.4 \ rlphy.4 route.4 scsi.4 sd.4 ses.4 sf.4 siop.4 sis.4 sk.4 sl.4 sm.4 \ spp.4 sppp.4 sqphy.4 ss.4 st.4 ste.4 sv.4 tb.4 tcic.4 tcp.4 termios.4 \ ti.4 tl.4 tlphy.4 tp.4 tqphy.4 tty.4 tun.4 twe.4 tx.4 txp.4 txphy.4 \ diff --git a/share/man/man4/man4.i386/Makefile b/share/man/man4/man4.i386/Makefile index a8c6bed53f9..614bbc04387 100644 --- a/share/man/man4/man4.i386/Makefile +++ b/share/man/man4/man4.i386/Makefile @@ -1,11 +1,11 @@ -# $OpenBSD: Makefile,v 1.40 2001/06/20 16:27:28 mpech Exp $ +# $OpenBSD: Makefile,v 1.41 2001/10/04 22:33:49 gluk Exp $ # from: @(#)Makefile 5.1 (Berkeley) 2/12/91 # Id: Makefile,v 1.4 1995/12/14 05:41:38 deraadt Exp $ -MAN= apm.4 autoconf.4 bios.4 bktr.4 gus.4 ie.4 intro.4 iy.4 joy.4 \ +MAN= apm.4 az.4 autoconf.4 bios.4 bktr.4 gus.4 ie.4 intro.4 iy.4 joy.4 \ le.4 lms.4 lpt.4 mcd.4 mem.4 mms.4 mtrr.4 npx.4 pcibios.4 \ pctr.4 pss.4 sb.4 \ - sea.4 speaker.4 uha.4 wdt.4 wss.4 wt.4 xf86.4 + sea.4 speaker.4 sf2r.4 sf4r.4 uha.4 wdt.4 wss.4 wt.4 xf86.4 MLINKS+= speaker.4 spkr.4 MLINKS+= mem.4 kmem.4 diff --git a/share/man/man4/man4.i386/az.4 b/share/man/man4/man4.i386/az.4 new file mode 100644 index 00000000000..52efccb0ea8 --- /dev/null +++ b/share/man/man4/man4.i386/az.4 @@ -0,0 +1,55 @@ +.\" $OpenBSD: az.4,v 1.1 2001/10/04 22:33:49 gluk Exp $ +.\" +.\" Copyright (c) 2001 Vladimir Popov +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF +.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +.\" ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd September 27, 2001 +.Dt AZ 4 +.Os +.Sh NAME +.Nm az +.Nd Aztech/PackardBell radio card device driver +.Sh SYNOPSIS +.Cd "az0 at isa? port 0x358" +.Cd "az0 at isa? port 0x350" +.Cd "radio* at az0" +.Sh DESCRIPTION +The +.Nm +driver provides support for the Aztech/PackardBell radio cards. +.Pp +The Aztech/PackardBell cards are stereo FM tuners that allow to tune +in the 87.5-108.0 MHz range. It is capable to report signal status +(tuned/not tuned, stereo/mono signal) and force audio output to mono. +.Pp +The Aztech cards use only one I/O port. The I/O port is set by the driver to +the value specified in the configuration file. The I/O port must be one of +0x350 and 0x358. +.Sh BUGS +It is impossible to determine which frequency the card is tuned to. Thus, +the driver will report an internally stored value even if it is not correct +(changed by some program that uses direct port access). +.Sh SEE ALSO +.Xr radio 4 , +.Xr isa 4 . + diff --git a/share/man/man4/man4.i386/sf2r.4 b/share/man/man4/man4.i386/sf2r.4 new file mode 100644 index 00000000000..179b427c560 --- /dev/null +++ b/share/man/man4/man4.i386/sf2r.4 @@ -0,0 +1,54 @@ +.\" $OpenBSD: sf2r.4,v 1.1 2001/10/04 22:33:49 gluk Exp $ +.\" +.\" Copyright (c) 2001 Vladimir Popov +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF +.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +.\" ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd September 27, 2001 +.Dt SF2R 4 +.Os +.Sh NAME +.Nm sf2r +.Nd SoundForte RadioLink SF16-FMR2 FM radio device driver +.Sh SYNOPSIS +.Cd "sf2r0 at isa? port 0x384" +.Cd "radio* at sf2r0" +.Sh DESCRIPTION +The +.Nm +driver provides support for the SF16-FMR2 FM radio tuners. +.Pp +The SF16-FMR2 is a stereo FM tuner that allows to tune in the range +87.5 - 108.0 MHz, report signal status on the current frequency, force +audio output to mono, perform hardware signal search, and has an internal +AFC. +.Pp +The SF16-FMR2 cards take only one I/O port. The I/O port is set by the driver +to the value specified in the configuration file and must be 0x384. +.Sh BUGS +MediaForte made two variants of the SF16-FMR2 cards, the first one has +an internal amplifier of the output sound, the second one does not have +such an amplifier. The current driver supports only the second variant. +.Sh SEE ALSO +.Xr radio 4 , +.Xr isa 4 . + diff --git a/share/man/man4/man4.i386/sf4r.4 b/share/man/man4/man4.i386/sf4r.4 new file mode 100644 index 00000000000..d33606c1275 --- /dev/null +++ b/share/man/man4/man4.i386/sf4r.4 @@ -0,0 +1,50 @@ +.\" $OpenBSD: sf4r.4,v 1.1 2001/10/04 22:33:49 gluk Exp $ +.\" +.\" Copyright (c) 2001 Vladimir Popov +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF +.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +.\" ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd September 27, 2001 +.Dt SF4R 4 +.Os +.Sh NAME +.Nm sf4r +.Nd SoundForte RadioLink SF64-PCR FM radio device driver +.Sh SYNOPSIS +.Cd "sf4r0 at pci?" +.Cd "radio* at sf4r0" +.Sh DESCRIPTION +The +.Nm +driver provides support for the SF64-PCR FM radio tuners. +.Pp +The SF64-PCR cards are stereo FM tuners that allow to tune in the range +87.5 - 108.0 MHz, report signal status on the current frequency, force +audio output to mono, perform hardware signal search, and have an internal +AFC. +.Sh BUGS +Because MediaForte put FM801 on the board, the current driver cannot +distinguish sound cards based on FM801 and SF64-PCR. +.Sh SEE ALSO +.Xr radio 4 , +.Xr pci 4 . + diff --git a/share/man/man4/radio.4 b/share/man/man4/radio.4 new file mode 100644 index 00000000000..2cdf38ade88 --- /dev/null +++ b/share/man/man4/radio.4 @@ -0,0 +1,130 @@ +.\" $OpenBSD: radio.4,v 1.1 2001/10/04 22:33:49 gluk Exp $ +.\" +.\" Copyright (c) 2001 Vladimir Popov +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF +.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +.\" ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd September 21, 2001 +.Dt RADIO 4 +.Os +.Sh NAME +.Nm radio +.Nd device-independent radio driver layer +.Sh SYNOPSIS +.Fd #include <sys/types.h> +.Fd #include <sys/ioctl.h> +.Fd #include <sys/radioio.h> +.Sh DESCRIPTION +The +.Nm +driver provides support for various FM radio cards. It provides an uniform +programming interface layer above different underlying radio hardware drivers. +.Pp +For radio tuner controlling there is a single device file available: +.Pa /dev/radio . +.Pp +The following +.Xr ioctl 2 +commands are supported: +.Pp +.Bl -tag -width indent -compact +.It Dv RIOCSMUTE (u_long) +This command mutes or unmutes the device. This operation does not affect +volume value of the device. +.It Dv RIOCGMUTE (u_long) +This command returns current mute state of the device. +.It Dv RIOCSMONO (u_long) +This command sets the device output to mono even if the device receive a stereo +signal (forced mono). +.It Dv RIOCGMONO (u_long) +This command returns current forced mono state of the device. +.It Dv RIOCGVOLU (u_long) +This command returns current volume of the device. +.It Dv RIOCSVOLU (u_long) +This command sets current volume of the device. +.It Dv RIOCGFREQ (u_long) +This command returns frequency the device is tuned to. +.It Dv RIOCSFREQ (u_long) +This command sets working frequency of the device. +.It Dv RIOCSSRCH (u_long) +This command assumes that a signal search is required and gives direction +of search to the driver - 0 to search down and any non-zero value to search up. +.It Dv RIOCGCAPS (u_long) +This command returns the device capabilities. The capabilities can have +following values: +.Bl -tag -width indent -compact +.It Dv RADIO_CAPS_DETECT_STEREO +The device can determine is it tuned to a stereo signal. +.It Dv RADIO_CAPS_DETECT_SIGNAL +The device can determine is it tuned or not. +.It Dv RADIO_CAPS_SET_MONO +The device capable to forcible set its output to mono. +.It Dv RADIO_CAPS_HW_SEARCH +The device can do hardware search. +.It Dv RADIO_CAPS_HW_AFC +The device has an internal hardware automatic frequency control. +.It Dv RADIO_CAPS_REFERENCE_FREQ +The device allow to change the reference frequency of a received signal. +.It Dv RADIO_CAPS_LOCK_SENSITIVITY +The device allow to change the station lock sensitivity used during search +operation. +.It Dv RADIO_CAPS_CARD_TYPE +Some cards have several different incarnations. This allow to determine +the variant of the card. Currently not used. +.El +.It Dv RIOCGINFO (u_long) +This commands returns current state of the device. +.Bl -tag -width indent -compact +.It Dv RADIO_INFO_SIGNAL +Informs whether the device receives a valid signal or noise. +.It Dv RADIO_INFO_STEREO +Informs whether the device receives a stereo or mono signal. +.El +.It Dv RIOCGREFF (u_long) +This command returns current value of the device's reference frequency. +.It Dv RIOCSREFF (u_long) +This command sets reference frequency of the device. +.It Dv RIOCGLOCK (u_long) +This command returns current value of the device's station lock sensitivity. +.It Dv RIOCSLOCK (u_long) +This command sets station lock sensitivity of the device. +.El +.Sh FILES +.Bl -tag -width /dev/radio -compact +.It Pa /dev/radio +.El +.Sh SEE ALSO +.Xr ioctl 2 . +.Pp +For ports using the ISA bus: +.Xr sf2r 4 , +.Xr az 4 . +.Pp +For ports using the PCI bus: +.Xr sf4r 4 . +.Sh BUGS +.Pp +You can have only one card of the same type. For example, if you have two +aztech FM tuners, the first card with jumper set to port 0x358 and the second +one - to 0x350, you can use only one aztech card (in the kernel, that is) +either with port 0x350 or 0x358. Don't even try to compile support for the +second card into the kernel. diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile index ab6ef683fcf..6ad8170411a 100644 --- a/share/man/man9/Makefile +++ b/share/man/man9/Makefile @@ -1,4 +1,4 @@ -# $OpenBSD: Makefile,v 1.41 2001/07/27 09:55:07 niklas Exp $ +# $OpenBSD: Makefile,v 1.42 2001/10/04 22:33:49 gluk Exp $ # $NetBSD: Makefile,v 1.4 1996/01/09 03:23:01 thorpej Exp $ # Makefile for section 9 (kernel function and variable) manual pages. @@ -11,7 +11,7 @@ MAN= altq.9 audio.9 boot.9 bus_dma.9 bus_space.9 copy.9 crypto.9 ctxsw.9 \ kthread.9 malloc.9 mbuf_tags.9 md5.9 microtime.9 \ panic.9 pfind.9 physio.9 \ pool.9 powerhook_establish.9 ppsratecheck.9 printf.9 psignal.9 \ - ratecheck.9 resettodr.9 random.9 \ + ratecheck.9 resettodr.9 radio.9 random.9 \ shutdownhook_establish.9 sleep.9 spl.9 startuphook_establish.9 \ store.9 style.9 \ time.9 timeout.9 uvm.9 \ diff --git a/share/man/man9/radio.9 b/share/man/man9/radio.9 new file mode 100644 index 00000000000..2e24657f076 --- /dev/null +++ b/share/man/man9/radio.9 @@ -0,0 +1,93 @@ +.\" $OpenBSD: radio.9,v 1.1 2001/10/04 22:33:49 gluk Exp $ +.\" +.\" Copyright (c) Maxim Tsyplakov <tm@oganer.net> +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF +.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +.\" ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd September 29, 2001 +.Dt RADIO 9 +.Os +.Sh NAME +.Nm radio +.Nd interface between low and high level radio drivers +.Sh DESCRIPTION +The radio device driver is divided into a high level, +hardware independent layer, and a low level hardware +dependent layer. +The interface between these is the +.Va radio_hw_if +structure. +.Bd -literal +struct radio_hw_if { + int *open(dev_t, int, int, struct proc *); + void *close(dev_t, int, int, struct proc *); + int *ioctl(dev_t, u_long, caddr_t, int, struct proc *); +}; + +.Ed +.Pp + +The high level radio driver attaches to the low level driver +when the latter calls +.Va radio_attach_mi . +This call should be +.Bd -literal + void + radio_attach_mi(rhwp, hdlp, dev) + struct radio_hw_if *rhwp; + void *hdlp; + struct device *dev; +.Ed +.Pp +The +.Va radio_hw_if +struct is as shown above. +The +.Va hdlp +argument is a handle to some low level data structure. +It is reserved field for future usage, and actually not used in any +low-level driver functions. +.Va radio_hw_if +when the high level driver calls them. +.Va dev +is the device struct for the hardware device. +.Pp + +The fields of +.Va radio_hw_if +are described in some more detail below. + +.Bd -literal +int open (dev_t dev, int flags, int fmt, struct proc *p); + Is called when the radio device is opened. + Returns 0 on success, otherwise an error code. + +int close (dev_t dev, int flags, int fmt, struct proc *p); + Is called when the radio device is closed. + Returns 0 on success, otherwise an error code. + +int ioctl (dev_t dev, u_long cmd, caddr_t data, int flags, struct proc *p); + Is ioctl requests handler function. + Returns 0 on success, otherwise an error code. + +.Sh SEE ALSO +.Xr radio 4 |