1.\" $NetBSD: scmdspi.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 SCMDSPI 4 19.Os 20.Sh NAME 21.Nm scmdspi 22.Nd SPI frontend to the Sparkfun Serial Controlled Motor Driver 23.Sh SYNOPSIS 24.Cd "scmd* at spi? slave 0" 25.Cd "scmd* at spi? slave 1" 26.Sh DESCRIPTION 27The 28.Nm 29driver provides the SPI frontend attachment for the Sparkfun SCMD device. 30.Sh SYSCTL VARIABLES 31The following 32.Xr sysctl 3 33variables are inherited from 34.Xr scmd 4 35: 36.Bl -tag -width indent 37.It Li hw.scmd0.debug 38If the driver is compiled with 39.Dv SCMD_DEBUG , 40this node will appear and can be used to set the debugging level. 41.El 42.Sh FILES 43.Bl -tag -width /dev/rcaXXXXX -compact 44.It Pa /dev/scmd Ns Ar u 45character device allowing access to the register space of a main 46.Ar u , 47SCMD device 48.Sh SEE ALSO 49.Xr iic 4 , 50.Xr spi 4 , 51.Xr scmdi2c 4 , 52.Xr scmdspi 4 , 53.Xr scmdctl 1 , 54.Xr sysctl 8 55.Sh HISTORY 56The 57.Nm 58driver first appeared in 59.Nx 10.0 . 60.Sh AUTHORS 61.An -nosplit 62The 63.Nm 64driver was written by 65.An Brad Spencer Aq Mt brad@anduin.eldar.org . 66.Sh BUGS 67When used in SPI mode, the SCMD device uses an odd method of doing reads 68that can become stuck. See the command spi_read_one in the 69.Xr scmdctl 1 70utility to try and unstick the device when this happens. 71 72