/share/man/man4/ubtbcmfw.4

  1.\" Copyright (c) 2003 Maksim Yevmenkin <m_evmenkin@yahoo.com>
  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.\" $Id: ubtbcmfw.4,v 1.3 2003/05/21 19:37:35 max Exp $
 26.\" $FreeBSD$
 27.\"
 28.Dd November 22, 2006
 29.Dt UBTBCMFW 4
 30.Os
 31.Sh NAME
 32.Nm ubtbcmfw
 33.Nd Firmware driver for Broadcom BCM2033 chip based Bluetooth USB devices
 34.Sh SYNOPSIS
 35To compile this driver into the kernel,
 36place the following line in your
 37kernel configuration file:
 38.Bd -ragged -offset indent
 39.Cd "device ubtbcmfw"
 40.Ed
 41.Pp
 42Alternatively, to load the driver as a
 43module at boot time, place the following line in
 44.Xr loader.conf 5 :
 45.Bd -literal -offset indent
 46ubtbcmfw_load="YES"
 47.Ed
 48.Sh DESCRIPTION
 49The
 50.Nm
 51is a firmware driver for Broadcom BCM2033 chip based Bluetooth USB devices.
 52It provides minimal access to the parts of the device required to download
 53firmware.
 54.Pp
 55The
 56.Nm
 57driver creates three fixed endpoint device nodes.
 58.Pp
 59The control transfers can only happen on the control endpoint which
 60is always endpoint 0.
 61Control requests are issued by
 62.Xr ioctl 2
 63calls.
 64.Pp
 65Only incoming transfers are supported on an interrupt endpoint.
 66To perform I/O on an interrupt endpoint,
 67.Xr read 2
 68should be used.
 69All I/O operations on an interrupt endpoint are unbuffered.
 70Interrupt endpoint is always endpoint 1.
 71.Pp
 72Only outgoing bulk transfers are supported on a bulk endpoint.
 73To perform I/O on a bulk endpoint,
 74.Xr write 2
 75should be used.
 76All I/O operations on a bulk endpoint are unbuffered.
 77Outgoing bulk endpoint is always endpoint 2.
 78.Pp
 79The control endpoint (endpoint 0) handles the following
 80.Xr ioctl 2
 81calls:
 82.Bl -tag -width indent
 83.It Dv USB_GET_DEVICE_DESC Pq Vt usb_device_descriptor_t
 84Return the device descriptor.
 85.El
 86.Sh FILES
 87.Bl -tag -width ".Pa /dev/ubtbcmfw Ns Ar N Ns Pa \&. Ns Ar EE" -compact
 88.It Pa /dev/ubtbcmfw Ns Ar N Ns Pa \&. Ns Ar EE
 89Endpoint
 90.Ar EE
 91of device
 92.Ar N .
 93.El
 94.Sh SEE ALSO
 95.Xr ng_ubt 4 ,
 96.Xr ugen 4 ,
 97.Xr usb 4 ,
 98.Xr bcmfw 8
 99.Sh HISTORY
100The
101.Nm
102driver was implemented in
103.Fx 5.0 .
104.Sh AUTHORS
105.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
106.Sh BUGS
107Most likely.
108Please report if found.