xref: /netbsd-src/share/man/man4/scmdi2c.4 (revision bf53d4416703565e0d45b6919cbfae62d21a4872)
1.\" $NetBSD: scmdi2c.4,v 1.1 2021/12/07 17:39:54 brad Exp $
2.\"
3.\" Copyright (c) 2021 Brad Spencer <brad@anduin.eldar.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd December 1, 2021
18.Dt SCMDI2C 4
19.Os
20.Sh NAME
21.Nm scmdi2c
22.Nd I2C frontend to the Sparkfun Serial Controlled Motor Driver
23.Sh SYNOPSIS
24.Cd "scmd* at iic? addr 0x58"
25.Cd "scmd* at iic? addr 0x59"
26.Cd "scmd* at iic? addr 0x5a"
27.Cd "scmd* at iic? addr 0x5b"
28.Cd "scmd* at iic? addr 0x5c"
29.Cd "scmd* at iic? addr 0x5d"
30.Cd "scmd* at iic? addr 0x5e"
31.Cd "scmd* at iic? addr 0x5f"
32.Cd "scmd* at iic? addr 0x60"
33.Cd "scmd* at iic? addr 0x61"
34.Sh DESCRIPTION
35The
36.Nm
37driver provides the I2C frontend attachment for the Sparkfun SCMD device.
38.Sh SYSCTL VARIABLES
39The following
40.Xr sysctl 3
41variables are inherited from
42.Xr scmd 4
43:
44.Bl -tag -width indent
45.It Li hw.scmd0.debug
46If the driver is compiled with
47.Dv SCMD_DEBUG ,
48this node will appear and can be used to set the debugging level.
49.El
50.Sh FILES
51.Bl -tag -width /dev/rcaXXXXX -compact
52.It Pa /dev/scmd Ns Ar u
53character device allowing access to the register space of a main
54.Ar u ,
55SCMD device
56.Sh SEE ALSO
57.Xr iic 4 ,
58.Xr spi 4 ,
59.Xr scmdi2c 4 ,
60.Xr scmdspi 4 ,
61.Xr scmdctl 1 ,
62.Xr sysctl 8
63.Sh HISTORY
64The
65.Nm
66driver first appeared in
67.Nx 10.0 .
68.Sh AUTHORS
69.An -nosplit
70The
71.Nm
72driver was written by
73.An Brad Spencer Aq Mt brad@anduin.eldar.org .
74