diff options
author | ru <ru@FreeBSD.org> | 2002-12-13 10:38:42 +0000 |
---|---|---|
committer | ru <ru@FreeBSD.org> | 2002-12-13 10:38:42 +0000 |
commit | c5a591f1addd844e34f85e260a14445753c82b9b (patch) | |
tree | cb6338b3b8398db49027108065a718bc0137bb17 /share/man/man4/ng_btsocket.4 | |
parent | 81e4753c41446e473eb1cf548cafc6114cfaf8fb (diff) | |
download | FreeBSD-src-c5a591f1addd844e34f85e260a14445753c82b9b.zip FreeBSD-src-c5a591f1addd844e34f85e260a14445753c82b9b.tar.gz |
mdoc(7) police: markup overhaul.
Diffstat (limited to 'share/man/man4/ng_btsocket.4')
-rw-r--r-- | share/man/man4/ng_btsocket.4 | 166 |
1 files changed, 92 insertions, 74 deletions
diff --git a/share/man/man4/ng_btsocket.4 b/share/man/man4/ng_btsocket.4 index bb2b360..7df217f 100644 --- a/share/man/man4/ng_btsocket.4 +++ b/share/man/man4/ng_btsocket.4 @@ -1,5 +1,3 @@ -.\" ng_btsocket.4 -.\" .\" Copyright (c) 2001-2002 Maksim Yevmenkin <m_evmenkin@yahoo.com> .\" All rights reserved. .\" @@ -24,13 +22,13 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $Id: ng_btsocket.4,v 1.4 2002/11/12 22:31:39 max Exp $ .\" $FreeBSD$ +.\" .Dd July 8, 2002 .Dt NG_BTSOCKET 4 .Os .Sh NAME -.Nm btsocket +.Nm ng_btsocket .Nd Bluetooth sockets layer .Sh SYNOPSIS .In sys/types.h @@ -43,23 +41,23 @@ .Sh DESCRIPTION The .Nm -module implements three Netgraph node types. Each type in its turn implements -one protocol within +module implements three Netgraph node types. +Each type in its turn implements one protocol within .Dv PF_BLUETOOTH domain. -.Pp -.Sh BLUETOOTH_PROTO_HCI protocol -.Ss SOCK_RAW HCI sockets +.Sh Dv BLUETOOTH_PROTO_HCI Sh protocol +.Ss Dv SOCK_RAW Ss HCI sockets Implemented by -.Cm btsock_hci_raw -Netgraph type. Raw HCI sockets allow sending of raw HCI command datagrams +.Nm btsock_hci_raw +Netgraph type. +Raw HCI sockets allow sending of raw HCI command datagrams only to correspondents named in .Xr send 2 -calls. Raw HCI datagrams (HCI commands, events and data) are generally -received with +calls. +Raw HCI datagrams (HCI commands, events and data) are generally received with .Xr recvfrom 2 , -which returns the next datagram with its return address. Also raw HCI -sockets can be used to control HCI nodes. +which returns the next datagram with its return address. +Raw HCI sockets can also be used to control HCI nodes. .Pp The Bluetooth raw HCI socket address is defined as follows: .Bd -literal -offset indent @@ -71,14 +69,14 @@ struct sockaddr_hci { }; .Ed .Pp -Raw HCI sockets support number of -.Xr ioctl 2 +Raw HCI sockets support number of +.Xr ioctl 2 requests such as: -.Bl -tag -width foo +.Bl -tag -width indent .It Dv SIOC_HCI_RAW_NODE_GET_STATE Returns current state for the HCI node. .It Dv SIOC_HCI_RAW_NODE_INIT -Turn on +Turn on .Dq inited bit for the HCI node. .It Dv SIOC_HCI_RAW_NODE_GET_DEBUG @@ -112,9 +110,10 @@ Returns current packet mask for the HCI node. Sets current packet mask for the HCI node. .El .Pp -Raw HCI sockets support filters. The application can filter certain -HCI datagram types. For HCI event datagrams the application can set -additional filter. The raw HCI socket filter defined as follows: +Raw HCI sockets support filters. +The application can filter certain HCI datagram types. +For HCI event datagrams the application can set additional filter. +The raw HCI socket filter defined as follows: .Bd -literal -offset indent /* * Raw HCI socket filter. @@ -129,17 +128,16 @@ struct ng_btsocket_hci_raw_filter { }; .Ed .Pp -The +The .Dv SO_HCI_RAW_FILTER option defined at -.Dv SOL_HCI_RAW +.Dv SOL_HCI_RAW level can be used to obtain via .Xr getsockopt 2 -or change via -.Xr setsockopt 2 +or change via +.Xr setsockopt 2 raw HCI socket's filter. -.Pp -.Sh BLUETOOTH_PROTO_L2CAP protocol +.Sh Dv BLUETOOTH_PROTO_L2CAP Sh protocol The Bluetooth L2CAP socket address is defined as follows: .Bd -literal -offset indent /* Bluetooth version of struct sockaddr for L2CAP sockets */ @@ -150,19 +148,23 @@ struct sockaddr_l2cap { bdaddr_t l2cap_bdaddr; /* address */ }; .Ed -.Pp -.Ss SOCK_RAW L2CAP sockets +.Ss Dv SOCK_RAW Ss L2CAP sockets Implemented by -.Cm btsock_l2c_raw +.Nm btsock_l2c_raw Netgraph type. -Raw L2CAP sockets do not provide access to raw L2CAP datagrams. These -sockets used to control L2CAP nodes and to issue special L2CAP requests -such as ECHO_REQUEST and GET_INFO request. +Raw L2CAP sockets do not provide access to raw L2CAP datagrams. +These +sockets used to control L2CAP nodes and to issue special L2CAP requests +such as +.Dv ECHO_REQUEST +and +.Dv GET_INFO +request. .Pp -Raw L2CAP sockets support number of -.Xr ioctl 2 +Raw L2CAP sockets support number of +.Xr ioctl 2 requests such as: -.Bl -tag -width foo +.Bl -tag -width indent .It Dv SIOC_L2CAP_NODE_GET_FLAGS Returns current state for the L2CAP node. .It Dv SIOC_L2CAP_NODE_GET_DEBUG @@ -175,81 +177,97 @@ node. .It Dv SIOC_L2CAP_NODE_GET_CHAN_LIST Returns list of active channels for the L2CAP node. .It Dv SIOC_L2CAP_L2CA_PING -Issues L2CAP ECHO_REQUEST. +Issues L2CAP +.Dv ECHO_REQUEST . .It Dv SIOC_L2CAP_L2CA_GET_INFO -Issues L2CAP GET_INFO request. +Issues L2CAP +.Dv GET_INFO +request. .El -.Pp -.Ss SOCK_SEQPACKET L2CAP sockets +.Ss Dv SOCK_SEQPACKET Ss L2CAP sockets Implemented by -.Cm btsock_l2c +.Nm btsock_l2c Netgraph type. -L2CAP sockets are either +L2CAP sockets are either .Dq active or .Dq passive . -Active sockets initiate connections to passive sockets. By default L2CAP -sockets are created active; to create a passive socket the +Active sockets initiate connections to passive sockets. +By default L2CAP sockets are created active; to create a passive socket the .Xr listen 2 -system call must be used after binding the socket with the +system call must be used after binding the socket with the .Xr bind 2 -system call. Only passive sockets may use the -.Xr accept 2 -call to accept incoming connections. Only active sockets may use the -.Xr connect 2 -call to initiate connections. +system call. +Only passive sockets may use the +.Xr accept 2 +call to accept incoming connections. +Only active sockets may use the +.Xr connect 2 +call to initiate connections. .Pp -L2CAP sockets supports -.Dq wildcard addressing . -In this case socket must be bound to -.Dv NG_HCI_BDADDR_ANY -address. Note that PSM (Protocol/Service Multiplexor) filed is always -required. Once a connection has been established the socket's address is -fixed by the peer entity's location. The address assigned the socket is -the address associated with the Bluetooth device through which packets are +L2CAP sockets support +.Dq "wildcard addressing" . +In this case, socket must be bound to +.Dv NG_HCI_BDADDR_ANY +address. +Note that PSM (Protocol/Service Multiplexor) filed is always +required. +Once a connection has been established the socket's address is +fixed by the peer entity's location. +The address assigned the socket is +the address associated with the Bluetooth device through which packets are being transmitted and received, and PSM (Protocol/Service Multiplexor). .Pp L2CAP sockets support number of options defined at -.Dv SOL_L2CAP -level which can be set with -.Xr setsockopt 2 -and tested with +.Dv SOL_L2CAP +level which can be set with +.Xr setsockopt 2 +and tested with .Xr getsockopt 2 : -.Bl -tag -width foo +.Bl -tag -width indent .It Dv SO_L2CAP_IMTU Get (set) maximum payload size the local socket is capable of accepting. .It Dv SO_L2CAP_OMTU Get maximum payload size the remote socket is capable of accepting. .It Dv SO_L2CAP_IFLOW -Get incoming flow specification for the socket. -.Em Not implemented . +Get incoming flow specification for the socket. +.Bf -emphasis +Not implemented. +.Ef .It Dv SO_L2CAP_OFLOW Get (set) outgoing flow specification for the socket. -.Em Not implemented . +.Bf -emphasis +Not implemented. +.Ef .It Dv SO_L2CAP_FLUSH Get (set) value of the flush timeout. -.Em Not implemeted . +.Bf -emphasis +Not implemeted. +.Ef .El .Sh HOOKS -This node type supports hooks with arbitrary names (as long as they are +This node type supports hooks with arbitrary names (as long as they are unique) and always accepts hook connection requests. .Sh NETGRAPH CONTROL MESSAGES This node type supports the generic control messages. .Sh SHUTDOWN These nodes are persistent and cannot be shut down. .Sh BUGS -Most likely. Please report if found. +Most likely. +Please report if found. .Sh SEE ALSO +.Xr btsockstat 1 , .Xr socket 2 , .Xr netgraph 4 , -.Xr ngctl 8 , .Xr ng_hci 4 , .Xr ng_l2cap 4 , -.Xr btsockstat 1 +.Xr ngctl 8 .Sh HISTORY The -.Nm -node type was implemented in +.Nm btsock_hci_raw , btsock_l2c_raw , +and +.Nm btsock_l2c +node types were implemented in .Fx 5.0 . .Sh AUTHORS .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com |