Make SPI direct configuration less #ifdef'y. No more checking what kind
of platform device tree; instead, use a device call to enumerate the
direct config children of the bus.

branches: 1.1.4;
Add userland driver to spi framework.

Previously spi would configure the controller to use the lowest speed of
all connected devices since the kernel started and to fail attempted mode
changes. This is now improved to keep individual modes and speeds for each
slave and to reconfigure the controller as necessary for each transfer.

Added man page for spi(9).

Re-reactor more common code.

Don't put SPI- or I2C-specific stuff in common code.

Define and use spi_handle_t to drive home the point that it's an opaque
type.

Lip-service to direct configuration. More work here is needed to conform
to the device tree bindings.

Use SPI_MATCH_DEFAULT rather than hard-coding 1.

Use speed calculation helper macros. This actally fixes tmp121, where
comment did not match code (comment was correct, confirmed against
data sheet).

Split the BMP280 / BME280 driver into common code and create I2C and
SPI attachments.

A driver for the NXP SC16IS7xx family of UART chips. This family is
mostly a 16C450 with features from the 16C550, 16C650 and 16C750 and
makes use of src/sys/dev/ic/com.c for much of the heavy lifting.

A BIG difference is that the chip family is attached via a I2C or SPI
bus and is in no way, shape or form, attached to the computer via a
computer bus.

Since spin locks are not allowed to be held while calling to the I2C
or SPI framework com.c grew a new hw feature flag where it could be
run at something other than a hard IP level and doesn't hold spin lock
(for very long). In particular, IPL_SOFTSERIAL. This method is
enabled via a hw feature flag and should not effect any other use of
com.c. Other changes with this new method of use include the use of
workqueues and such.

A further feature added to com.c was the abilty to take advantage of
the MCR prescaler that is present in the SC16IS7xx family and likely
present in the 16C650. This prescaler is tried if the baud rate
requested can not be met with the frequency oscillator that the chip is
built with.

The chip family does not use any particular frequency oscillator for
the baud rate generator. In order to deal with this the frequency can
be set via sysctl, a kernel option or with a FDT overlay if that is
supported.

Most of the features of the chip family are supported including the
gpio pins via gpiobus(4) that are present with some of the family
members.

The chip can attach via I2C or SPI and can make sure of FDT if that is
present in the system.

This chip family has been around for quite some time and there are a
number of breakout boards on Amazon. It is also reasonably priced and
you can roll your own board if you can perform simple SMD soldering as
very few additional components are required.

If using FDT, get Vref from the device tree per the documented bindings
for this device.

Step towards modularizing the Flattened Device Tree code.

Define attributes for each of the specific device bindings: clock,
dai, dma, gpio, i2c, iommu, mbox, mmc_pwrseq, phy, power, power domain,
pwm, regulator, reset controller, spi, system controller, pin
controller. Include these support files only if either a provider
or consumer with one of these attributes is present in the kernel
config.

Add the necessary attributes to the device / attach declarations for
each provider and consumer.

There are some bindings that are consumed by generic code (iommu, pinctrl,
power, power domain). Provide weak stubs for these routines to handle
situations where there is no provider.

No actual code changed; NFCI.

Split the BMP280 / BME280 driver into common code and create I2C and
SPI attachments.

Re-factor and overhaul the "mcp23s17gpio" driver as "mcpgpio", and
add support for 8-bit and I2C variants of the chip:
- MCP23008 / MCP23S08: 8-bit (I2C / SPI)
- MCP23017 / MCP23S17: 16-bit (I2C / SPI)
- MCP23018 / MCP23S18: 16-bit (I2C / SPI), open-drain outputs

The MCP23x17 and MCP23x18 are essentially identical, software-wise; we
merely report different GPIO pin capabilities (no push-pull output for
MCP23x18). Also, remove the tri-state capability that was previously
advertised by the old version of this driver; these chips have no way
to put the pin into a HI-Z mode.

All 3 I2C versions are supported, but the SPI front-end still only
supports the MCP23S17 for now (SPI autoconfiguration needs an overhaul).

mcp23s17gpio(4) remains present as a link to the new mcpgpio(4) man page.

XXX Still to-do: FDT integration, interrupt suppoort.

A driver and user land utility for the Sparkfun Serial Controlled Motor
Driver module as illustrated here:

https://www.sparkfun.com/products/13911

A SCMD module is a ARM SOC simular to a Arduino in front of a motor
driver chip. The single SCMD module can control two motors and up to
16 additional modules can be chained together using an internal I2C
bus. One can interface with the SCMD using tty uart commands, SPI or
I2C. The driver in this commit adds a kernel driver for the I2C and
SPI interfaces. The command line utility provides a set of
convenience commands that support most of the functions of the SCMD
and is able to use the tty uart mode, SPI user land or the included
kernel driver in a uniform manor.

The use of the SCMD module is mostly for small robots and the like,
but it can control anything that is controllable by voltage.

add spi(4) bus frontend for ssdfb(4)

spi: make the "slave" config(5) locator optional

needed to be able to support FDT direct attachment of SPI slaves

branches: 1.5.18;
MI driver for the Microchip 3x0x series of SAR analog to digital converters.

branches: 1.4.4;
add Microchip MCP23S17 GPIO driver
(via SPI interface)

branches: 1.3.2;
Add preliminary driver for Microchip MCP48x1 family of DACs.

Needs more testing and an appropriate API for such (non-audio) DACs. For now
one can set the output value using sysctl node. Also sysmon(4) will conveniently
report the voltage on Vout pin of the DAC. Note that this is not an actual
measured voltage, but merely calculated using equation from datasheet. Real
voltage might be different and depend on analog circuitry attached to the DAC.

branches: 1.2.2; 1.2.4; 1.2.8; 1.2.38; 1.2.94; 1.2.104; 1.2.110; 1.2.114;
Add spiflash driver, and M25P instance, used for STMicro flash devices
found on Meraki Mini (for example).

Initial commit of SPI bus (also known as Microwire) framework, along with
a sample driver for the TI TMP121 temperature sensor. This has been
moderately tested on Au1550, and it is not enabled in sys/conf (yet). So
the change is harmless at worst, and useful at best.

Alchemy Au1550 bus driver forthcoming, along with a driver for SPI flash
devices, such as found on the Meraki Mini

This development was partially funded by the Champaign-Urbana Community
Wireless Network Project.

Note that there are some MD-specific SPI drivers that could probably be
made MI under this new framework.

Define and use spi_handle_t to drive home the point that it's an opaque
type.

Don't report spi_configure() errors here.

Use spi_use_direct_match().

Use speed calculation helper macros. This actally fixes tmp121, where
comment did not match code (comment was correct, confirmed against
data sheet).

Pass the device_t into spi_configure(), and make the API contract that
spi_configure() will print errors if they occur; the driver is off the
hook.

Probe / match routines should not have side-effects: do the spi_configure()
calls in the attach routines.

branches: 1.18.8;
Replace aprint_error with aprint_error_dev in config_interrupts callback.

branches: 1.17.4; 1.17.6;
Use DEVICE_COMPAT_EOL.

Use designated initializers and a consistent termination style in
compat_data[].

branches: 1.15.8;
Change manufacturer to Micron from Numonyx.

N25Q -> MT25Q

On second thought revert that. Let's open this can of worms some other day.

KB -> kB

Add support for Winbond W25Q128.V (128mb) chips, as found on newer lime2-emmc
boards.
While there fix a missing \n in dmesg.

m25p: add compatible entry for "jedec,spi-nor" and match on it

m25p: change devices recently added from 4kB "sector size" to 64kB ...

... even though it is wrong and these devices really use 4kB sector size.
Despite the struct member being named sector size it is actually used as
block size. Our spiflash driver doesn't issue sector erase commands.
Stopgap measure to fix data corruption until the driver is fixed.

m25p: add GigaDevice 25Q127CSIG

(This is the boot ROM found on ROCKPro64.)

m25p: add some ~2010 vintage parts found in junk drawer

m25p: print vendor & device id before bailing out on unknown devices

branches: 1.6.4;
Add four Winbond devices.

Add support Microchip SST25VF016B.
- Fixed imxspi send and receive bugs.

branches: 1.4.6;
Add support for M25P16, tested on Raspberry PI with Digilent PmodSF.

branches: 1.3.4;
Add support for STMicro M25PX64 and Numonyx N25Q128.

Obtained from Marvell, Semihalf.

branches: 1.2.34; 1.2.44;
device_t/softc split.

branches: 1.1.2; 1.1.4; 1.1.8; 1.1.54; 1.1.56; 1.1.58;
Add spiflash driver, and M25P instance, used for STMicro flash devices
found on Meraki Mini (for example).

Re-factor and overhaul the "mcp23s17gpio" driver as "mcpgpio", and
add support for 8-bit and I2C variants of the chip:
- MCP23008 / MCP23S08: 8-bit (I2C / SPI)
- MCP23017 / MCP23S17: 16-bit (I2C / SPI)
- MCP23018 / MCP23S18: 16-bit (I2C / SPI), open-drain outputs

The MCP23x17 and MCP23x18 are essentially identical, software-wise; we
merely report different GPIO pin capabilities (no push-pull output for
MCP23x18). Also, remove the tri-state capability that was previously
advertised by the old version of this driver; these chips have no way
to put the pin into a HI-Z mode.

All 3 I2C versions are supported, but the SPI front-end still only
supports the MCP23S17 for now (SPI autoconfiguration needs an overhaul).

mcp23s17gpio(4) remains present as a link to the new mcpgpio(4) man page.

XXX Still to-do: FDT integration, interrupt suppoort.

branches: 1.4.2;
Merge thorpej-cfargs2.

branches: 1.3.2;
Fix all remaining typos, mainly in comments but also in few definitions and log messages, reported by me in PR kern/54889.
Also fixed some additional typos in comments, found on review of same files or typos.

branches: 1.2.2;
Merge thorpej-cfargs branch:

Simplify and make extensible the config_search() / config_found() /
config_attach() interfaces: rather than having different variants for
which arguments you want pass along, just have a single call that
takes a variadic list of tag-value arguments.

Adjust all call sites:
- Simplify wherever possible; don't pass along arguments that aren't
actually needed.
- Don't be explicit about what interface attribute is attaching if
the device only has one. (More simplification.)
- Add a config_probe() function to be used in indirect configuiration
situations, making is visibly easier to see when indirect config is
in play, and allowing for future change in semantics. (As of now,
this is just a wrapper around config_match(), but that is an
implementation detail.)

Remove unnecessary or redundant interface attributes where they're not
needed.

There are currently 5 "cfargs" defined:
- CFARG_SUBMATCH (submatch function for direct config)
- CFARG_SEARCH (search function for indirect config)
- CFARG_IATTR (interface attribte)
- CFARG_LOCATORS (locators array)
- CFARG_DEVHANDLE (devhandle_t - wraps OFW, ACPI, etc. handles)

...and a sentinel value CFARG_EOL.

Add some extra sanity checking to ensure that interface attributes
aren't ambiguous.

Use CFARG_DEVHANDLE in MI FDT, OFW, and ACPI code, and macppc and shark
ports to associate those device handles with device_t instance. This
will trickle trough to more places over time (need back-end for pre-OFW
Sun OBP; any others?).

branches: 1.1.2; 1.1.4; 1.1.6; 1.1.10; 1.1.52;
add Microchip MCP23S17 GPIO driver
(via SPI interface)

Re-factor and overhaul the "mcp23s17gpio" driver as "mcpgpio", and
add support for 8-bit and I2C variants of the chip:
- MCP23008 / MCP23S08: 8-bit (I2C / SPI)
- MCP23017 / MCP23S17: 16-bit (I2C / SPI)
- MCP23018 / MCP23S18: 16-bit (I2C / SPI), open-drain outputs

The MCP23x17 and MCP23x18 are essentially identical, software-wise; we
merely report different GPIO pin capabilities (no push-pull output for
MCP23x18). Also, remove the tri-state capability that was previously
advertised by the old version of this driver; these chips have no way
to put the pin into a HI-Z mode.

All 3 I2C versions are supported, but the SPI front-end still only
supports the MCP23S17 for now (SPI autoconfiguration needs an overhaul).

mcp23s17gpio(4) remains present as a link to the new mcpgpio(4) man page.

XXX Still to-do: FDT integration, interrupt suppoort.

branches: 1.1.2; 1.1.4; 1.1.6; 1.1.10;
add Microchip MCP23S17 GPIO driver
(via SPI interface)

Define and use spi_handle_t to drive home the point that it's an opaque
type.

Enable direct configuration via the device tree.

Use SPI_MATCH_DEFAULT rather than hard-coding 1.

Use speed calculation helper macros. This actally fixes tmp121, where
comment did not match code (comment was correct, confirmed against
data sheet).

Pass the device_t into spi_configure(), and make the API contract that
spi_configure() will print errors if they occur; the driver is off the
hook.

Probe / match routines should not have side-effects: do the spi_configure()
calls in the attach routines.

G/C mcpgpio_softc::sc_phandle; nothing is using it.

Re-factor and overhaul the "mcp23s17gpio" driver as "mcpgpio", and
add support for 8-bit and I2C variants of the chip:
- MCP23008 / MCP23S08: 8-bit (I2C / SPI)
- MCP23017 / MCP23S17: 16-bit (I2C / SPI)
- MCP23018 / MCP23S18: 16-bit (I2C / SPI), open-drain outputs

The MCP23x17 and MCP23x18 are essentially identical, software-wise; we
merely report different GPIO pin capabilities (no push-pull output for
MCP23x18). Also, remove the tri-state capability that was previously
advertised by the old version of this driver; these chips have no way
to put the pin into a HI-Z mode.

All 3 I2C versions are supported, but the SPI front-end still only
supports the MCP23S17 for now (SPI autoconfiguration needs an overhaul).

mcp23s17gpio(4) remains present as a link to the new mcpgpio(4) man page.

XXX Still to-do: FDT integration, interrupt suppoort.

Define and use spi_handle_t to drive home the point that it's an opaque
type.

Simplify mcp3kadc_lookup().

If using FDT, get Vref from the device tree per the documented bindings
for this device.

Support direct configuration.

- Better validation of user-specified model via config file flags.
- Store a pointer to the model data, not an index into the model data table.

NFC.

Use speed calculation helper macros. This actally fixes tmp121, where
comment did not match code (comment was correct, confirmed against
data sheet).

Pass the device_t into spi_configure(), and make the API contract that
spi_configure() will print errors if they occur; the driver is off the
hook.

Probe / match routines should not have side-effects: do the spi_configure()
calls in the attach routines.

branches: 1.2.14; 1.2.36; 1.2.46;
Fixed typo in name for MCP3304.

branches: 1.1.2; 1.1.4;
MI driver for the Microchip 3x0x series of SAR analog to digital converters.

Define and use spi_handle_t to drive home the point that it's an opaque
type.

Support direct configuration.

Use SPI_MATCH_DEFAULT rather than hard-coding 1.

Use speed calculation helper macros. This actally fixes tmp121, where
comment did not match code (comment was correct, confirmed against
data sheet).

Pass the device_t into spi_configure(), and make the API contract that
spi_configure() will print errors if they occur; the driver is off the
hook.

Probe / match routines should not have side-effects: do the spi_configure()
calls in the attach routines.

branches: 1.1.4; 1.1.6; 1.1.10; 1.1.54; 1.1.64;
Add preliminary driver for Microchip MCP48x1 family of DACs.

Needs more testing and an appropriate API for such (non-audio) DACs. For now
one can set the output value using sysctl node. Also sysmon(4) will conveniently
report the voltage on Vout pin of the DAC. Note that this is not an actual
measured voltage, but merely calculated using equation from datasheet. Real
voltage might be different and depend on analog circuitry attached to the DAC.

Define and use spi_handle_t to drive home the point that it's an opaque
type.

Use spi_use_direct_match().

Use speed calculation helper macros. This actally fixes tmp121, where
comment did not match code (comment was correct, confirmed against
data sheet).

Pass the device_t into spi_configure(), and make the API contract that
spi_configure() will print errors if they occur; the driver is off the
hook.

Probe / match routines should not have side-effects: do the spi_configure()
calls in the attach routines.

branches: 1.9.2;
Merge thorpej-cfargs2.

branches: 1.8.2; 1.8.8;
Merge thorpej-cfargs branch:

Simplify and make extensible the config_search() / config_found() /
config_attach() interfaces: rather than having different variants for
which arguments you want pass along, just have a single call that
takes a variadic list of tag-value arguments.

Adjust all call sites:
- Simplify wherever possible; don't pass along arguments that aren't
actually needed.
- Don't be explicit about what interface attribute is attaching if
the device only has one. (More simplification.)
- Add a config_probe() function to be used in indirect configuiration
situations, making is visibly easier to see when indirect config is
in play, and allowing for future change in semantics. (As of now,
this is just a wrapper around config_match(), but that is an
implementation detail.)

Remove unnecessary or redundant interface attributes where they're not
needed.

There are currently 5 "cfargs" defined:
- CFARG_SUBMATCH (submatch function for direct config)
- CFARG_SEARCH (search function for indirect config)
- CFARG_IATTR (interface attribte)
- CFARG_LOCATORS (locators array)
- CFARG_DEVHANDLE (devhandle_t - wraps OFW, ACPI, etc. handles)

...and a sentinel value CFARG_EOL.

Add some extra sanity checking to ensure that interface attributes
aren't ambiguous.

Use CFARG_DEVHANDLE in MI FDT, OFW, and ACPI code, and macppc and shark
ports to associate those device handles with device_t instance. This
will trickle trough to more places over time (need back-end for pre-OFW
Sun OBP; any others?).

branches: 1.7.2;
Use DEVICE_COMPAT_EOL.

Use designated initializers and a consistent termination style in
compat_data[].

branches: 1.5.8;
Make this at least compile - I have no way to test.

Fix typo.

Avoid workqueue_check_duplication().

branches: 1.2.18;
use workqueue(9)

branches: 1.1.4; 1.1.6; 1.1.10; 1.1.12;
Add optical joystick support for NetWalker.
+ OJ6SH-T25 (Sharp "Optical TOUCH CRUISER" sensor)
+ 2 Mouse buttons (GPIO)

Address a couple of problems with the sc16ix7xx(4) driver, noticed
when you have a bus that can detach, such as presented by the
umcpmio(4) driver.

o The dev/ic/com.c code pretty much assumed that it was using a device
on a computer bus and as such the registers would not suddenly
disappear out from under it. This won't be the case with the
sc16is7xx(4) driver. However, the code in dev/ic/com.c is not at all
structured in a manor that handles a failure to do a read or write.
Generally, this won't be a problem, except for comintr() which is the
interrupt handler. When called in polled mode, especially, it is
possible that the code in comintr() can get stuck in one of its loops
because it will NEVER get the values it expects back from the device
if the device disappears. To deal with this introduce a out of band
way to indicate that a read or write failed and check that in
comintr(). This allows it to exit out in a sane manor. This along
with the corresponding changes to the attachment specific code fixes a
problem where the system could (and probably would) hang up hard if
the device disappeared (comintr() would be running in a VERY tight
loop hogging everything). Note that the enable / disable support that
com.c has wasn't enough to deal with this, as the call into comintr()
could already have been in flight and well on its way to getting
stuck.


o Use the proper softc in the CFATTACH_DECL_ call for the I2C and SPI
attachments. I don't know what I was thinking at the time. Fixes a
problem where the system will panic in a unusual way if the device is
detached and then reattached.

A driver for the NXP SC16IS7xx family of UART chips. This family is
mostly a 16C450 with features from the 16C550, 16C650 and 16C750 and
makes use of src/sys/dev/ic/com.c for much of the heavy lifting.

A BIG difference is that the chip family is attached via a I2C or SPI
bus and is in no way, shape or form, attached to the computer via a
computer bus.

Since spin locks are not allowed to be held while calling to the I2C
or SPI framework com.c grew a new hw feature flag where it could be
run at something other than a hard IP level and doesn't hold spin lock
(for very long). In particular, IPL_SOFTSERIAL. This method is
enabled via a hw feature flag and should not effect any other use of
com.c. Other changes with this new method of use include the use of
workqueues and such.

A further feature added to com.c was the abilty to take advantage of
the MCR prescaler that is present in the SC16IS7xx family and likely
present in the 16C650. This prescaler is tried if the baud rate
requested can not be met with the frequency oscillator that the chip is
built with.

The chip family does not use any particular frequency oscillator for
the baud rate generator. In order to deal with this the frequency can
be set via sysctl, a kernel option or with a FDT overlay if that is
supported.

Most of the features of the chip family are supported including the
gpio pins via gpiobus(4) that are present with some of the family
members.

The chip can attach via I2C or SPI and can make sure of FDT if that is
present in the system.

This chip family has been around for quite some time and there are a
number of breakout boards on Amazon. It is also reasonably priced and
you can roll your own board if you can perform simple SMD soldering as
very few additional components are required.

Define and use spi_handle_t to drive home the point that it's an opaque
type.

Support direct configuration via device tree.

Use speed calculation helper macros. This actally fixes tmp121, where
comment did not match code (comment was correct, confirmed against
data sheet).

scmdspi.c: minor spelling and grammar tweaks to comments

branches: 1.3.10;
Pass the device_t into spi_configure(), and make the API contract that
spi_configure() will print errors if they occur; the driver is off the
hook.

Probe / match routines should not have side-effects: do the spi_configure()
calls in the attach routines.

A driver and user land utility for the Sparkfun Serial Controlled Motor
Driver module as illustrated here:

https://www.sparkfun.com/products/13911

A SCMD module is a ARM SOC simular to a Arduino in front of a motor
driver chip. The single SCMD module can control two motors and up to
16 additional modules can be chained together using an internal I2C
bus. One can interface with the SCMD using tty uart commands, SPI or
I2C. The driver in this commit adds a kernel driver for the I2C and
SPI interfaces. The command line utility provides a set of
convenience commands that support most of the functions of the SCMD
and is able to use the tty uart mode, SPI user land or the included
kernel driver in a uniform manor.

The use of the SCMD module is mostly for small robots and the like,
but it can control anything that is controllable by voltage.

Add a detach call to the CFATTACH_ define mostly so that the children
so the right thing. This isn't very useful right now, but will become
more useful with a driver that will be landing in the near future.

Add another convenience wrapper function to the SPI framework.

spi_sendv(spi_handle_t sh, const struct iovec *iov,
int iovcnt)

Takes a iovec of buffers and sends them as one transaction down the
SPI bus.

There exists devices that will not handle sending the register that is
to be written to as one transaction and the data as a second
transaction. That is, use one spi_send() to send the register and a
second spi_send() to send the data. Those devices require a single
transaction with both parts in it.

Fix typo in the indirect config case.

In spi_configure() attempt to fetch transfer mode information from the
platform device tree. Implement this for FDT per the SPI controller and
periperal Device Tree bindings.

Make SPI direct configuration less #ifdef'y. No more checking what kind
of platform device tree; instead, use a device call to enumerate the
direct config children of the bus.

Re-factor the logic of attaching child devices to share more between
the direct an indirect cases.

Define and use spi_handle_t to drive home the point that it's an opaque
type.

Introduce spi_use_direct_match() which, like its i2c cousin, informs
the driver if a direct config match is in play, allowing the driver
more easily apply direct vs indirect config match logic.

In the direct config case, use the correct spi_handle for the child
device (index the array using the slave #, not the child_devices array
index).

Don't pass a "cookie" in the attach args to SPI devices. Instead,
properly initialize the child device's device handle. G/C unused
fields in spi_attach_args.

Put the task of getting the device array from the FDT onto the
SPI bus attach routine. This is slightly ugly now, but a prettier
solution is on the way, and this at least funnels the ugliness into
a single location.

- Const poison references to spi_controller.
- Don't make a copy of the spi_controller in the SPI bus softc; just take
a reference to the one we got from the back-end driver.

Register the SPI controller with FDT in spi_attach(), not in each
driver.

fix few typos in comments.

Trailing whitespace

Fix sanity check for zero sized buffer.

Provide a spi_compatible_lookup() function to go along with
spi_compatible_match().

Stash the device_t in spi_softc.

Try to fix the build.

Pass the device_t into spi_configure(), and make the API contract that
spi_configure() will print errors if they occur; the driver is off the
hook.

branches: 1.19.2;
Merge thorpej-cfargs2.

branches: 1.18.4;
Protect ioctl and declare MPSAFE.

branches: 1.17.2; 1.17.4;
Merge thorpej-cfargs branch:

Simplify and make extensible the config_search() / config_found() /
config_attach() interfaces: rather than having different variants for
which arguments you want pass along, just have a single call that
takes a variadic list of tag-value arguments.

Adjust all call sites:
- Simplify wherever possible; don't pass along arguments that aren't
actually needed.
- Don't be explicit about what interface attribute is attaching if
the device only has one. (More simplification.)
- Add a config_probe() function to be used in indirect configuiration
situations, making is visibly easier to see when indirect config is
in play, and allowing for future change in semantics. (As of now,
this is just a wrapper around config_match(), but that is an
implementation detail.)

Remove unnecessary or redundant interface attributes where they're not
needed.

There are currently 5 "cfargs" defined:
- CFARG_SUBMATCH (submatch function for direct config)
- CFARG_SEARCH (search function for indirect config)
- CFARG_IATTR (interface attribte)
- CFARG_LOCATORS (locators array)
- CFARG_DEVHANDLE (devhandle_t - wraps OFW, ACPI, etc. handles)

...and a sentinel value CFARG_EOL.

Add some extra sanity checking to ensure that interface attributes
aren't ambiguous.

Use CFARG_DEVHANDLE in MI FDT, OFW, and ACPI code, and macppc and shark
ports to associate those device handles with device_t instance. This
will trickle trough to more places over time (need back-end for pre-OFW
Sun OBP; any others?).

branches: 1.16.2;
Change the device_compatible_match() function to only perform the match.
Introduce a device_compatible_lookup() function to return an entry based
on the same matching criteria (a'la of_search_compatible()).

Update iic_compatible_match() to reflect the above change, and introduce
iic_compatible_lookup(). This pattern is less awkward to use.

branches: 1.15.2;
Use mutex for lwp/interrupt coordination. using splX() simply does not work
on multiprocessor systems.

fixes PR kern/55506

Update for proplib(3) API changes.

Remove GPIO driver attach defer.

spi: prepare for fdt direct attachment of spi slaves

Introduce sba_child_devices array in spibus_attach_args. If the parent has
populated sba_child_devices then attach them first. Then do any devices
devices the user has wired in the kernel config, if any.

branches: 1.11.4;
More input validation. Fix off-by-1 for size limit.

Add userland driver to spi framework.

Previously spi would configure the controller to use the lowest speed of
all connected devices since the kernel started and to fail attempted mode
changes. This is now improved to keep individual modes and speeds for each
slave and to reconfigure the controller as necessary for each transfer.

Added man page for spi(9).

Rename min/max -> uimin/uimax for better honesty.

These functions are defined on unsigned int. The generic name
min/max should not silently truncate to 32 bits on 64-bit systems.
This is purely a name change -- no functional change intended.

HOWEVER! Some subsystems have

#define min(a, b) ((a) < (b) ? (a) : (b))
#define max(a, b) ((a) > (b) ? (a) : (b))

even though our standard name for that is MIN/MAX. Although these
may invite multiple evaluation bugs, these do _not_ cause integer
truncation.

To avoid `fixing' these cases, I first changed the name in libkern,
and then compile-tested every file where min/max occurred in order to
confirm that it failed -- and thus confirm that nothing shadowed
min/max -- before changing it.

I have left a handful of bootloaders that are too annoying to
compile-test, and some dead code:

cobalt ews4800mips hp300 hppa ia64 luna68k vax
acorn32/if_ie.c (not included in any kernels)
macppc/if_gm.c (superseded by gem(4))

It should be easy to fix the fallout once identified -- this way of
doing things fails safe, and the goal here, after all, is to _avoid_
silent integer truncations, not introduce them.

Maybe one day we can reintroduce min/max as type-generic things that
never silently truncate. But we should avoid doing that for a while,
so that existing code has a chance to be detected by the compiler for
conversion to uimin/uimax without changing the semantics until we can
properly audit it all. (Who knows, maybe in some cases integer
truncation is actually intended!)

branches: 1.8.6; 1.8.36; 1.8.38;
Fix usage of uninitialised variable holding number of slave devices.
The sc_nslaves has to be initialised before it is used in allocation of a memory holding save devices' configuration, otherwise slave drivers are causing kernel crashes.

Patch from Semihalf.
Author: Michal Dubiel <md@semihalf.com>

Don't leak condvars and mutexes, even if they are on the stack.
Fixes LOCKDEBUG asserts when a mutex/condvar is initialized at the same
stack address as a previous initialization. We probably want to revisit
the transfer structure lifecyle at some point in the future.

branches: 1.6.2; 1.6.8; 1.6.12;
initialise chuck_rptr as well, instead of chuck_read twice.

- Use IPL_BIO (instead of IPL_SERIAL) for SPI.
- Convert simple_lock/ltsleep to mutex/condvar.

branches: 1.4.6;
Fix the while condition: sleep while the SPI_F_DONE bit is not set.

'!' takes precedence over bitwise operation '&', so use parenthesis.

branches: 1.3.20; 1.3.22;
device_t/softc split.

branches: 1.2.2; 1.2.4; 1.2.8; 1.2.54; 1.2.56; 1.2.58;
Add spiflash driver, and M25P instance, used for STMicro flash devices
found on Meraki Mini (for example).

Initial commit of SPI bus (also known as Microwire) framework, along with
a sample driver for the TI TMP121 temperature sensor. This has been
moderately tested on Au1550, and it is not enabled in sys/conf (yet). So
the change is harmless at worst, and useful at best.

Alchemy Au1550 bus driver forthcoming, along with a driver for SPI flash
devices, such as found on the Meraki Mini

This development was partially funded by the Champaign-Urbana Community
Wireless Network Project.

Note that there are some MD-specific SPI drivers that could probably be
made MI under this new framework.

In spi_configure() attempt to fetch transfer mode information from the
platform device tree. Implement this for FDT per the SPI controller and
periperal Device Tree bindings.

Make SPI direct configuration less #ifdef'y. No more checking what kind
of platform device tree; instead, use a device call to enumerate the
direct config children of the bus.

Regen for spi_calls,v 1.2

Regen for spi_calls 1.1.

branches: 1.1.4;
Add userland driver to spi framework.

Previously spi would configure the controller to use the lowest speed of
all connected devices since the kernel started and to fail attempted mode
changes. This is now improved to keep individual modes and speeds for each
slave and to reconfigure the controller as necessary for each transfer.

Added man page for spi(9).

branches: 1.1.2;
file spi_obuf.c was initially added on branch matt-nb4-arm.

Define and use spi_handle_t to drive home the point that it's an opaque
type.

fix various typos in comments and makefs README file.

Trailing whitespace

Merge thorpej-cfargs2.

branches: 1.24.8;
Merge thorpej-cfargs branch:

Simplify and make extensible the config_search() / config_found() /
config_attach() interfaces: rather than having different variants for
which arguments you want pass along, just have a single call that
takes a variadic list of tag-value arguments.

Adjust all call sites:
- Simplify wherever possible; don't pass along arguments that aren't
actually needed.
- Don't be explicit about what interface attribute is attaching if
the device only has one. (More simplification.)
- Add a config_probe() function to be used in indirect configuiration
situations, making is visibly easier to see when indirect config is
in play, and allowing for future change in semantics. (As of now,
this is just a wrapper around config_match(), but that is an
implementation detail.)

Remove unnecessary or redundant interface attributes where they're not
needed.

There are currently 5 "cfargs" defined:
- CFARG_SUBMATCH (submatch function for direct config)
- CFARG_SEARCH (search function for indirect config)
- CFARG_IATTR (interface attribte)
- CFARG_LOCATORS (locators array)
- CFARG_DEVHANDLE (devhandle_t - wraps OFW, ACPI, etc. handles)

...and a sentinel value CFARG_EOL.

Add some extra sanity checking to ensure that interface attributes
aren't ambiguous.

Use CFARG_DEVHANDLE in MI FDT, OFW, and ACPI code, and macppc and shark
ports to associate those device handles with device_t instance. This
will trickle trough to more places over time (need back-end for pre-OFW
Sun OBP; any others?).

branches: 1.23.10;
On second thought revert that. Let's open this can of worms some other day.

KB -> kB

Rename min/max -> uimin/uimax for better honesty.

These functions are defined on unsigned int. The generic name
min/max should not silently truncate to 32 bits on 64-bit systems.
This is purely a name change -- no functional change intended.

HOWEVER! Some subsystems have

#define min(a, b) ((a) < (b) ? (a) : (b))
#define max(a, b) ((a) > (b) ? (a) : (b))

even though our standard name for that is MIN/MAX. Although these
may invite multiple evaluation bugs, these do _not_ cause integer
truncation.

To avoid `fixing' these cases, I first changed the name in libkern,
and then compile-tested every file where min/max occurred in order to
confirm that it failed -- and thus confirm that nothing shadowed
min/max -- before changing it.

I have left a handful of bootloaders that are too annoying to
compile-test, and some dead code:

cobalt ews4800mips hp300 hppa ia64 luna68k vax
acorn32/if_ie.c (not included in any kernels)
macppc/if_gm.c (superseded by gem(4))

It should be easy to fix the fallout once identified -- this way of
doing things fails safe, and the goal here, after all, is to _avoid_
silent integer truncations, not introduce them.

Maybe one day we can reintroduce min/max as type-generic things that
never silently truncate. But we should avoid doing that for a while,
so that existing code has a chance to be detected by the compiler for
conversion to uimin/uimax without changing the semantics until we can
properly audit it all. (Who knows, maybe in some cases integer
truncation is actually intended!)

branches: 1.20.2; 1.20.4;
We always need bp->b_resid initialized before we try to toss the transfer.

Reset b_resid when tossing transfer with non-zero b_error.

need to forward the data pointer

Use C99-style initializers for struct dkdriver.

branches: 1.16.2;
use disk_init() wrapper function instead of poking data structures.

Add d_discard to all struct cdevsw instances I could find.

All have been set to "nodiscard"; some should get a real implementation.

Add d_discard to all struct bdevsw instances I could find.

I've set them all to nodiscard. Some of them (wd, dk, vnd, ld,
raidframe, maybe cgd) should be implemented for real.

branches: 1.13.2;
Fix printf formating in DPRINTF.

Remove an unused variable

branches: 1.11.2;
Fix wrong calculation of destination pointer in writes.

Existing calculation of destination pointer was always causing unnecessary erases of SPI Flash memory and was always writing each consecutive 2048 byte blocks of data into the same address of the SPI Flash memory. This commit fixes issue with writes of multiple blocks using 'dd' tool.

Patch from Semihalf.
Author: Michal Dubiel <md@semihalf.com>

branches: 1.10.14; 1.10.24;
g/c BUFQ_FOO() macros and use bufq_foo() directly.

branches: 1.9.4;
use device_lookup_private to get softc

branches: 1.8.2; 1.8.4;
device_t/softc split.

branches: 1.7.2; 1.7.4;
use aprint_*_dev and device_xname

branches: 1.6.26; 1.6.28;
It's not a good idea for device drivers to modify b_flags, as they don't
need to understand the locking around that field. Instead of setting
B_ERROR, set b_error instead. b_error is 'owned' by whoever completes
the I/O request.

Fix the kthread_create(9) call so this compiles again.

branches: 1.4.2;
Merge some of the less invasive changes from the vmlocking branch:

- kthread, callout, devsw API changes
- select()/poll() improvements
- miscellaneous MT safety improvements

branches: 1.3.2; 1.3.4;
Kill caddr_t; there will be some MI fallout, but it will be fixed shortly.

branches: 1.2.2; 1.2.4; 1.2.8; 1.2.10;
This commit provides substantial fixes and functionality for SPI flash.

Specifically, the SPI flash now operates as a nearly fully functional block
device (other than lacking disklabel support). It does some basic translation
stuff, so that if you attempt to write a block, the underlying flash sectors
(usually 64k in size) will be read, erased and rewritten.

To minize thrashing, the spiflash strategy routine attempts to gather writes
to the same sector together, so that in the typical case you will not have to
repeatedly erase/rewrite the sector. It also attempts to check and verify
whether an erase cycle is truly needed. There are still access patterns that
will cause multiple erases to occur, and so I heartily discourage the use
of these flash devices for storing anything other than small configuration
data, or write-once images. If you want to do more than that, then someone
should try to write a real flash translation layer.

The drivers attempt to provide some level of asynchronous operation, so that
while you are erasing or writing to the flash, other things can reasonably
take place.

Note that spiflash does not do bad block remapping. It also doesn't detect
when a device is in read-only mode, or if some sectors are read-only. It
only supports uniform sectored NOR flash. It lacks any code to deal with
disklabels, and does not offer any disk related ioctls.

These limitations aside, it would not be terribly hard, I think, to break
out the code I've done to create a generic "norflash" driver, backed by
a "common" spiflash module. Then other flash drivers (e.g. athflash, etc.)
could benefit from the ability to use this as a block device. I've tried
to architect it to support that, if someone else wants to do the work.
(Hi Jared!)

The primary reason that I've not added code to deal with disklabels is that
I had a difficult time figuring out which framework (disklabels or wedges)
to use, and which bits of code were necessary to implement. In the case of
the flash devices I'm working with, a parser to deal with redboot FIS images
(partitions) would need to be added. I was prepared to do this, but gave
up owing to the complete and total lack of any API or design documentation
pertaining to the requirements for disk drivers and disklabel management or
wedges. I would strongly encourage someone who knows something about
wedges or disklabels to write a simple document (or even a dummy driver)
showing which interfaces should be provided in new mass storage drivers.

This work was funded by the Champaign-Urbana Community Wireless Network
Project.

Add spiflash driver, and M25P instance, used for STMicro flash devices
found on Meraki Mini (for example).

Define and use spi_handle_t to drive home the point that it's an opaque
type.

struct device * -> device_t, no functional changes intended.

branches: 1.3.2; 1.3.46; 1.3.62;
Spell "separate" correctly. From Zafer Aydogan.

fix spelling of accommodate; from Zapher.

branches: 1.1.2; 1.1.4;
Add spiflash driver, and M25P instance, used for STMicro flash devices
found on Meraki Mini (for example).

Add another convenience wrapper function to the SPI framework.

spi_sendv(spi_handle_t sh, const struct iovec *iov,
int iovcnt)

Takes a iovec of buffers and sends them as one transaction down the
SPI bus.

There exists devices that will not handle sending the register that is
to be written to as one transaction and the data as a second
transaction. That is, use one spi_send() to send the register and a
second spi_send() to send the data. Those devices require a single
transaction with both parts in it.

In spi_configure() attempt to fetch transfer mode information from the
platform device tree. Implement this for FDT per the SPI controller and
periperal Device Tree bindings.

Make SPI direct configuration less #ifdef'y. No more checking what kind
of platform device tree; instead, use a device call to enumerate the
direct config children of the bus.

Re-factor the logic of attaching child devices to share more between
the direct an indirect cases.

Define and use spi_handle_t to drive home the point that it's an opaque
type.

Introduce spi_use_direct_match() which, like its i2c cousin, informs
the driver if a direct config match is in play, allowing the driver
more easily apply direct vs indirect config match logic.

Don't pass a "cookie" in the attach args to SPI devices. Instead,
properly initialize the child device's device handle. G/C unused
fields in spi_attach_args.

Put the task of getting the device array from the FDT onto the
SPI bus attach routine. This is slightly ugly now, but a prettier
solution is on the way, and this at least funnels the ugliness into
a single location.

- Const poison references to spi_controller.
- Don't make a copy of the spi_controller in the SPI bus softc; just take
a reference to the one we got from the back-end driver.

Also be explicit about the interface attribute.

Pass the controller's device handle down to the SPI bus instance.

Encapsulate what's needed to attach a SPI bus into a spibus_attach()
inline.

Minor formatting beautification.

Define mode macros for CPOL and CPHA, and define SPI_MODE_* in terms
of CPOL and CPHA. Add SPI_FREQ_*() helper macros to make setting the
transfer frequency less error prone.

branches: 1.12.4;
Provide a spi_compatible_lookup() function to go along with
spi_compatible_match().

Pass the device_t into spi_configure(), and make the API contract that
spi_configure() will print errors if they occur; the driver is off the
hook.

branches: 1.10.6; 1.10.16;
Use mutex for lwp/interrupt coordination. using splX() simply does not work
on multiprocessor systems.

fixes PR kern/55506

Remove GPIO driver attach defer.

spi: prepare for fdt direct attachment of spi slaves

Introduce sba_child_devices array in spibus_attach_args. If the parent has
populated sba_child_devices then attach them first. Then do any devices
devices the user has wired in the kernel config, if any.

branches: 1.7.4;
Add userland driver to spi framework.

Previously spi would configure the controller to use the lowest speed of
all connected devices since the kernel started and to fail attempted mode
changes. This is now improved to keep individual modes and speeds for each
slave and to reconfigure the controller as necessary for each transfer.

Added man page for spi(9).

branches: 1.6.28;
"peripheral", not "peripherial".

branches: 1.5.2;
G/C sys/simplelock.h includes

branches: 1.4.2; 1.4.12; 1.4.16; 1.4.20;
- Use IPL_BIO (instead of IPL_SERIAL) for SPI.
- Convert simple_lock/ltsleep to mutex/condvar.

branches: 1.3.32; 1.3.42;
explicitly include simplelock.h

branches: 1.2.2; 1.2.4; 1.2.8; 1.2.30; 1.2.36; 1.2.44;
Add spiflash driver, and M25P instance, used for STMicro flash devices
found on Meraki Mini (for example).

Initial commit of SPI bus (also known as Microwire) framework, along with
a sample driver for the TI TMP121 temperature sensor. This has been
moderately tested on Au1550, and it is not enabled in sys/conf (yet). So
the change is harmless at worst, and useful at best.

Alchemy Au1550 bus driver forthcoming, along with a driver for SPI flash
devices, such as found on the Meraki Mini

This development was partially funded by the Champaign-Urbana Community
Wireless Network Project.

Note that there are some MD-specific SPI drivers that could probably be
made MI under this new framework.

Define and use spi_handle_t to drive home the point that it's an opaque
type.

Use spi_use_direct_match().

Don't pass a "cookie" in the attach args to SPI devices. Instead,
properly initialize the child device's device handle. G/C unused
fields in spi_attach_args.

Use speed calculation helper macros. This actally fixes tmp121, where
comment did not match code (comment was correct, confirmed against
data sheet).

Use spi_compatible_lookup().

Pass the device_t into spi_configure(), and make the API contract that
spi_configure() will print errors if they occur; the driver is off the
hook.

Probe / match routines should not have side-effects: do the spi_configure()
calls in the attach routines.

ssdfb: add support for SSD1306 and SH1106 at spi attachment

Only support the 4-wire mode for now. Support for 3-wire mode is
theoretically possible but most (all?) modules in circulation have the
BS0 / IM0 3-wire config pin internally grounded within the flat-flex
assembly so it is not easy to enable & test.

ssdfb_spi: fix issues with command xfers needed for SSD1306 & SH1106

These controllers require D/C# to be deasserted for the entire duration
of the command, contrary to docs and how newer controllers like SSD1353
behave. Probably this is needed for all controllers that do not have the
WRITE_RAM (0x5c) command. Also support using alternate padding commands
for 3-wire mode when WRITE_RAM is not available.

branches: 1.9.2;
ssdfb: fix some constant names. NFC because the same cmd code is used

ssdfb: support SSD1353 at spi(4)

ssdfb: support having an optional reset pin

ssdfb: support the 4-wire SPI interface

branches: 1.5.4;
Use DEVICE_COMPAT_EOL.

Use designated initializers and a consistent termination style in
compat_data[].

branches: 1.3.8; 1.3.10;
add fdt device_compatible_entry

fix hang when SSDFB_ATTACH_FLAG_CONSOLE used with spi

add spi(4) bus frontend for ssdfb(4)

Define and use spi_handle_t to drive home the point that it's an opaque
type.

Don't report spi_configure() errors here.

Support direct configuration.

Use SPI_MATCH_DEFAULT rather than hard-coding 1.

Use speed calculation helper macros. This actally fixes tmp121, where
comment did not match code (comment was correct, confirmed against
data sheet).

Pass the device_t into spi_configure(), and make the API contract that
spi_configure() will print errors if they occur; the driver is off the
hook.

Probe / match routines should not have side-effects: do the spi_configure()
calls in the attach routines.

branches: 1.5.72; 1.5.82;
Initialize sensor state before registering

branches: 1.4.36;
Split device_t/softc and other related cosmetic changes.

branches: 1.3.14;
Extend the envsys2 API (one more time, sorry) as defined in:

http://mail-index.netbsd.org/tech-kern/2007/11/09/0001.html

sysmon_envsys_create() and sysmon_envsys_destroy() were added to
create/destroy sysmon_envsys objects (and its TAILQ/LIST for sensors/events).

sysmon_envsys_sensor_attach() and sysmon_envsys_sensor_detach() were
added to attach/detach sensors to a specified sysmon_envsys device.

The events framework is now per device and configurable via the
ENVSYS_SETDICTIONARY ioctl or /etc/envsys.conf and envstat(8).

Update all users and documentation to reflect these changes.

branches: 1.2.6; 1.2.8; 1.2.12; 1.2.14;
Imported envsys 2, a brief description of the new features:
(Part 2: drivers)

* Support for detachable sensors.
* Cleaned up the API for simplicity and efficiency.
* Ability to send capacity/critical/warning events to powerd(8).
* Adapted all the code to the new locking order.
* Compatibility with the old envsys API: the ENVSYS_GTREINFO
and ENVSYS_GTREDATA ioctl(2)s are supported.
* Added support for a 'dictionary based communication channel' between
sysmon_power(9) and powerd(8), that means there is no 32 bytes event
size restriction anymore.
* Binary compatibility with old envstat(8) and powerd(8) via COMPAT_40.
* All drivers with the n^2 gtredata bug were fixed, PR kern/36226.

Tested by:

blymn: smsc(4).
bouyer: ipmi(4), mfi(4).
kefren: ug(4).
njoly: viaenv(4), adt7463.c.
riz: owtemp(4).
xtraeme: acpiacad(4), acpibat(4), acpitz(4), aiboost(4), it(4), lm(4).

branches: 1.1.2; 1.1.4; 1.1.8; 1.1.14; 1.1.16;
Initial commit of SPI bus (also known as Microwire) framework, along with
a sample driver for the TI TMP121 temperature sensor. This has been
moderately tested on Au1550, and it is not enabled in sys/conf (yet). So
the change is harmless at worst, and useful at best.

Alchemy Au1550 bus driver forthcoming, along with a driver for SPI flash
devices, such as found on the Meraki Mini

This development was partially funded by the Champaign-Urbana Community
Wireless Network Project.

Note that there are some MD-specific SPI drivers that could probably be
made MI under this new framework.