1998-09-03 20:52:54 +00:00
|
|
|
/*-
|
2017-11-27 14:52:40 +00:00
|
|
|
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
|
|
|
|
|
*
|
1998-09-03 20:52:54 +00:00
|
|
|
* Copyright (c) 1998 Nicolas Souchu
|
|
|
|
|
* All rights reserved.
|
|
|
|
|
*
|
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
|
* are met:
|
|
|
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
* notice, this list of conditions and the following disclaimer.
|
|
|
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
* documentation and/or other materials provided with the distribution.
|
|
|
|
|
*
|
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
|
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
|
* SUCH DAMAGE.
|
|
|
|
|
*
|
1999-08-28 01:08:13 +00:00
|
|
|
* $FreeBSD$
|
1998-09-03 20:52:54 +00:00
|
|
|
*/
|
2017-10-01 19:03:21 +00:00
|
|
|
#ifndef __DEV_SMBUS_SMBCONF_H
|
|
|
|
|
#define __DEV_SMBUS_SMBCONF_H
|
1998-09-03 20:52:54 +00:00
|
|
|
|
|
|
|
|
#include <sys/queue.h>
|
|
|
|
|
|
1999-01-27 19:58:53 +00:00
|
|
|
#define SMBPRI (PZERO+8) /* XXX sleep/wakeup queue priority */
|
1998-09-03 20:52:54 +00:00
|
|
|
|
|
|
|
|
#define n(flags) (~(flags) & (flags))
|
|
|
|
|
|
2016-10-12 06:58:01 +00:00
|
|
|
/* Order constants for smbus children. */
|
|
|
|
|
#define SMBUS_ORDER_HINTED 20
|
|
|
|
|
#define SMBUS_ORDER_PNP 40
|
|
|
|
|
|
1998-09-03 20:52:54 +00:00
|
|
|
/*
|
|
|
|
|
* How tsleep() is called in smb_request_bus().
|
|
|
|
|
*/
|
|
|
|
|
#define SMB_DONTWAIT 0
|
|
|
|
|
#define SMB_NOINTR 0
|
|
|
|
|
#define SMB_WAIT 0x1
|
|
|
|
|
#define SMB_INTR 0x2
|
|
|
|
|
|
1998-10-31 11:39:54 +00:00
|
|
|
/*
|
|
|
|
|
* callback index
|
|
|
|
|
*/
|
|
|
|
|
#define SMB_REQUEST_BUS 0x1
|
|
|
|
|
#define SMB_RELEASE_BUS 0x2
|
|
|
|
|
|
1998-09-03 20:52:54 +00:00
|
|
|
/*
|
|
|
|
|
* SMB bus errors
|
|
|
|
|
*/
|
|
|
|
|
#define SMB_ENOERR 0x0
|
|
|
|
|
#define SMB_EBUSERR 0x1
|
1998-10-31 11:39:54 +00:00
|
|
|
#define SMB_ENOTSUPP 0x2
|
1999-02-13 17:57:19 +00:00
|
|
|
#define SMB_ENOACK 0x4
|
|
|
|
|
#define SMB_ECOLLI 0x8
|
|
|
|
|
#define SMB_EABORT 0x10
|
|
|
|
|
#define SMB_ETIMEOUT 0x20
|
|
|
|
|
#define SMB_EBUSY 0x40
|
Minor overhaul of SMBus support:
- Change smbus_callback() to pass a void * rather than caddr_t.
- Change smbus_bread() to pass a pointer to the count and have it be an
in/out parameter. The input is the size of the buffer (same as before),
but on return it will contain the actual amount of data read back from
the bus. Note that this value may be larger than the input value. It
is up to the caller to treat this as an error if desired.
- Change the SMB_BREAD ioctl to write out the updated struct smbcmd which
will contain the actual number of bytes read in the 'count' field. To
preserve the previous ABI, the old ioctl value is mapped to SMB_OLD_BREAD
which doesn't copy the updated smbcmd back out to userland. I doubt anyone
actually used the old BREAD anyway as it was rediculous to do a bulk-read
but not tell the using program how much data was actually read.
- Make the smbus driver and devclass public in the smbus module and
push all the DRIVER_MODULE()'s for attaching the smbus driver to
various foosmb drivers out into the foosmb modules. This makes all
the foosmb logic centralized and allows new foosmb modules to be
self-contained w/o having to hack smbus.c everytime a new smbus driver
is added.
- Add a new SMB_EINVAL error bit and use it in place of EINVAL to return
an error for bad arguments (such as invalid counts for bread and bwrite).
- Map SMB bus error bits to EIO in smbus_error().
- Make the smbus driver call bus_generic_probe() and require child drivers
such as smb(4) to create device_t's via identify routines. Previously,
smbus just created one anonymous device during attach, and if you had
multiple drivers that could attach it was just random chance as to which
driver got to probe for the sole device_t first.
- Add a mutex to the smbus(4) softc and use it in place of dummy splhigh()
to protect the 'owner' field and perform necessary synchronization for
smbus_request_bus() and smbus_release_bus().
- Change the bread() and bwrite() methods of alpm(4), amdpm(4), and
viapm(4) to only perform a single transaction and not try to use a
loop of multiple transactions for a large request. The framing and
commands to use for a large transaction depend on the upper-layer
protocol (such as SSIF for IPMI over SMBus) from what I can tell, and the
smb(4) driver never allowed bulk read/writes of more than 32-bytes
anyway. The other smb drivers only performed single transactions.
- Fix buffer overflows in the bread() methods of ichsmb(4), alpm(4),
amdpm(4), amdsmb(4), intpm(4), and nfsmb(4).
- Use SMB_xxx errors in viapm(4).
- Destroy ichsmb(4)'s mutex after bus_generic_detach() to avoid problems
from child devices making smb upcalls that would use the mutex during
their detach methods.
MFC after: 1 week
Reviewed by: jmg (mostly)
2006-09-11 20:52:41 +00:00
|
|
|
#define SMB_EINVAL 0x100
|
1998-09-03 20:52:54 +00:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* How Quick command is executed
|
|
|
|
|
*/
|
|
|
|
|
#define SMB_QWRITE 0x0
|
|
|
|
|
#define SMB_QREAD 0x1
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* ivars codes
|
|
|
|
|
*/
|
2015-04-25 16:15:01 +00:00
|
|
|
enum smbus_ivars {
|
|
|
|
|
SMBUS_IVAR_ADDR, /* slave address of the device */
|
|
|
|
|
};
|
1998-09-03 20:52:54 +00:00
|
|
|
|
Minor overhaul of SMBus support:
- Change smbus_callback() to pass a void * rather than caddr_t.
- Change smbus_bread() to pass a pointer to the count and have it be an
in/out parameter. The input is the size of the buffer (same as before),
but on return it will contain the actual amount of data read back from
the bus. Note that this value may be larger than the input value. It
is up to the caller to treat this as an error if desired.
- Change the SMB_BREAD ioctl to write out the updated struct smbcmd which
will contain the actual number of bytes read in the 'count' field. To
preserve the previous ABI, the old ioctl value is mapped to SMB_OLD_BREAD
which doesn't copy the updated smbcmd back out to userland. I doubt anyone
actually used the old BREAD anyway as it was rediculous to do a bulk-read
but not tell the using program how much data was actually read.
- Make the smbus driver and devclass public in the smbus module and
push all the DRIVER_MODULE()'s for attaching the smbus driver to
various foosmb drivers out into the foosmb modules. This makes all
the foosmb logic centralized and allows new foosmb modules to be
self-contained w/o having to hack smbus.c everytime a new smbus driver
is added.
- Add a new SMB_EINVAL error bit and use it in place of EINVAL to return
an error for bad arguments (such as invalid counts for bread and bwrite).
- Map SMB bus error bits to EIO in smbus_error().
- Make the smbus driver call bus_generic_probe() and require child drivers
such as smb(4) to create device_t's via identify routines. Previously,
smbus just created one anonymous device during attach, and if you had
multiple drivers that could attach it was just random chance as to which
driver got to probe for the sole device_t first.
- Add a mutex to the smbus(4) softc and use it in place of dummy splhigh()
to protect the 'owner' field and perform necessary synchronization for
smbus_request_bus() and smbus_release_bus().
- Change the bread() and bwrite() methods of alpm(4), amdpm(4), and
viapm(4) to only perform a single transaction and not try to use a
loop of multiple transactions for a large request. The framing and
commands to use for a large transaction depend on the upper-layer
protocol (such as SSIF for IPMI over SMBus) from what I can tell, and the
smb(4) driver never allowed bulk read/writes of more than 32-bytes
anyway. The other smb drivers only performed single transactions.
- Fix buffer overflows in the bread() methods of ichsmb(4), alpm(4),
amdpm(4), amdsmb(4), intpm(4), and nfsmb(4).
- Use SMB_xxx errors in viapm(4).
- Destroy ichsmb(4)'s mutex after bus_generic_detach() to avoid problems
from child devices making smb upcalls that would use the mutex during
their detach methods.
MFC after: 1 week
Reviewed by: jmg (mostly)
2006-09-11 20:52:41 +00:00
|
|
|
int smbus_request_bus(device_t, device_t, int);
|
|
|
|
|
int smbus_release_bus(device_t, device_t);
|
|
|
|
|
device_t smbus_alloc_bus(device_t);
|
|
|
|
|
int smbus_error(int error);
|
1998-09-03 20:52:54 +00:00
|
|
|
|
Minor overhaul of SMBus support:
- Change smbus_callback() to pass a void * rather than caddr_t.
- Change smbus_bread() to pass a pointer to the count and have it be an
in/out parameter. The input is the size of the buffer (same as before),
but on return it will contain the actual amount of data read back from
the bus. Note that this value may be larger than the input value. It
is up to the caller to treat this as an error if desired.
- Change the SMB_BREAD ioctl to write out the updated struct smbcmd which
will contain the actual number of bytes read in the 'count' field. To
preserve the previous ABI, the old ioctl value is mapped to SMB_OLD_BREAD
which doesn't copy the updated smbcmd back out to userland. I doubt anyone
actually used the old BREAD anyway as it was rediculous to do a bulk-read
but not tell the using program how much data was actually read.
- Make the smbus driver and devclass public in the smbus module and
push all the DRIVER_MODULE()'s for attaching the smbus driver to
various foosmb drivers out into the foosmb modules. This makes all
the foosmb logic centralized and allows new foosmb modules to be
self-contained w/o having to hack smbus.c everytime a new smbus driver
is added.
- Add a new SMB_EINVAL error bit and use it in place of EINVAL to return
an error for bad arguments (such as invalid counts for bread and bwrite).
- Map SMB bus error bits to EIO in smbus_error().
- Make the smbus driver call bus_generic_probe() and require child drivers
such as smb(4) to create device_t's via identify routines. Previously,
smbus just created one anonymous device during attach, and if you had
multiple drivers that could attach it was just random chance as to which
driver got to probe for the sole device_t first.
- Add a mutex to the smbus(4) softc and use it in place of dummy splhigh()
to protect the 'owner' field and perform necessary synchronization for
smbus_request_bus() and smbus_release_bus().
- Change the bread() and bwrite() methods of alpm(4), amdpm(4), and
viapm(4) to only perform a single transaction and not try to use a
loop of multiple transactions for a large request. The framing and
commands to use for a large transaction depend on the upper-layer
protocol (such as SSIF for IPMI over SMBus) from what I can tell, and the
smb(4) driver never allowed bulk read/writes of more than 32-bytes
anyway. The other smb drivers only performed single transactions.
- Fix buffer overflows in the bread() methods of ichsmb(4), alpm(4),
amdpm(4), amdsmb(4), intpm(4), and nfsmb(4).
- Use SMB_xxx errors in viapm(4).
- Destroy ichsmb(4)'s mutex after bus_generic_detach() to avoid problems
from child devices making smb upcalls that would use the mutex during
their detach methods.
MFC after: 1 week
Reviewed by: jmg (mostly)
2006-09-11 20:52:41 +00:00
|
|
|
void smbus_intr(device_t, u_char, char low, char high, int error);
|
1998-09-03 20:52:54 +00:00
|
|
|
|
2015-04-25 16:15:01 +00:00
|
|
|
#define SMBUS_ACCESSOR(var, ivar, type) \
|
|
|
|
|
__BUS_ACCESSOR(smbus, var, SMBUS, ivar, type)
|
|
|
|
|
|
|
|
|
|
SMBUS_ACCESSOR(addr, ADDR, int)
|
|
|
|
|
|
|
|
|
|
#undef SMBUS_ACCESSOR
|
Minor overhaul of SMBus support:
- Change smbus_callback() to pass a void * rather than caddr_t.
- Change smbus_bread() to pass a pointer to the count and have it be an
in/out parameter. The input is the size of the buffer (same as before),
but on return it will contain the actual amount of data read back from
the bus. Note that this value may be larger than the input value. It
is up to the caller to treat this as an error if desired.
- Change the SMB_BREAD ioctl to write out the updated struct smbcmd which
will contain the actual number of bytes read in the 'count' field. To
preserve the previous ABI, the old ioctl value is mapped to SMB_OLD_BREAD
which doesn't copy the updated smbcmd back out to userland. I doubt anyone
actually used the old BREAD anyway as it was rediculous to do a bulk-read
but not tell the using program how much data was actually read.
- Make the smbus driver and devclass public in the smbus module and
push all the DRIVER_MODULE()'s for attaching the smbus driver to
various foosmb drivers out into the foosmb modules. This makes all
the foosmb logic centralized and allows new foosmb modules to be
self-contained w/o having to hack smbus.c everytime a new smbus driver
is added.
- Add a new SMB_EINVAL error bit and use it in place of EINVAL to return
an error for bad arguments (such as invalid counts for bread and bwrite).
- Map SMB bus error bits to EIO in smbus_error().
- Make the smbus driver call bus_generic_probe() and require child drivers
such as smb(4) to create device_t's via identify routines. Previously,
smbus just created one anonymous device during attach, and if you had
multiple drivers that could attach it was just random chance as to which
driver got to probe for the sole device_t first.
- Add a mutex to the smbus(4) softc and use it in place of dummy splhigh()
to protect the 'owner' field and perform necessary synchronization for
smbus_request_bus() and smbus_release_bus().
- Change the bread() and bwrite() methods of alpm(4), amdpm(4), and
viapm(4) to only perform a single transaction and not try to use a
loop of multiple transactions for a large request. The framing and
commands to use for a large transaction depend on the upper-layer
protocol (such as SSIF for IPMI over SMBus) from what I can tell, and the
smb(4) driver never allowed bulk read/writes of more than 32-bytes
anyway. The other smb drivers only performed single transactions.
- Fix buffer overflows in the bread() methods of ichsmb(4), alpm(4),
amdpm(4), amdsmb(4), intpm(4), and nfsmb(4).
- Use SMB_xxx errors in viapm(4).
- Destroy ichsmb(4)'s mutex after bus_generic_detach() to avoid problems
from child devices making smb upcalls that would use the mutex during
their detach methods.
MFC after: 1 week
Reviewed by: jmg (mostly)
2006-09-11 20:52:41 +00:00
|
|
|
|
|
|
|
|
extern driver_t smbus_driver;
|
|
|
|
|
extern devclass_t smbus_devclass;
|
1998-09-03 20:52:54 +00:00
|
|
|
|
|
|
|
|
#define smbus_quick(bus,slave,how) \
|
|
|
|
|
(SMBUS_QUICK(device_get_parent(bus), slave, how))
|
|
|
|
|
#define smbus_sendb(bus,slave,byte) \
|
|
|
|
|
(SMBUS_SENDB(device_get_parent(bus), slave, byte))
|
|
|
|
|
#define smbus_recvb(bus,slave,byte) \
|
|
|
|
|
(SMBUS_RECVB(device_get_parent(bus), slave, byte))
|
|
|
|
|
#define smbus_writeb(bus,slave,cmd,byte) \
|
|
|
|
|
(SMBUS_WRITEB(device_get_parent(bus), slave, cmd, byte))
|
|
|
|
|
#define smbus_writew(bus,slave,cmd,word) \
|
|
|
|
|
(SMBUS_WRITEW(device_get_parent(bus), slave, cmd, word))
|
|
|
|
|
#define smbus_readb(bus,slave,cmd,byte) \
|
|
|
|
|
(SMBUS_READB(device_get_parent(bus), slave, cmd, byte))
|
|
|
|
|
#define smbus_readw(bus,slave,cmd,word) \
|
|
|
|
|
(SMBUS_READW(device_get_parent(bus), slave, cmd, word))
|
|
|
|
|
#define smbus_pcall(bus,slave,cmd,sdata,rdata) \
|
|
|
|
|
(SMBUS_PCALL(device_get_parent(bus), slave, cmd, sdata, rdata))
|
|
|
|
|
#define smbus_bwrite(bus,slave,cmd,count,buf) \
|
|
|
|
|
(SMBUS_BWRITE(device_get_parent(bus), slave, cmd, count, buf))
|
|
|
|
|
#define smbus_bread(bus,slave,cmd,count,buf) \
|
|
|
|
|
(SMBUS_BREAD(device_get_parent(bus), slave, cmd, count, buf))
|
2015-04-25 16:15:01 +00:00
|
|
|
#define smbus_trans(bus,slave,cmd,op,wbuf,wcount,rbuf,rcount,actualp) \
|
|
|
|
|
(SMBUS_TRANS(device_get_parent(bus), slave, cmd, op, \
|
|
|
|
|
wbuf, wcount, rbuf, rcount, actualp))
|
1998-09-03 20:52:54 +00:00
|
|
|
|
2002-03-23 15:49:15 +00:00
|
|
|
#define SMBUS_MODVER 1
|
|
|
|
|
#define SMBUS_MINVER 1
|
|
|
|
|
#define SMBUS_MAXVER 1
|
|
|
|
|
#define SMBUS_PREFVER SMBUS_MODVER
|
|
|
|
|
|
2017-10-01 19:03:21 +00:00
|
|
|
#endif /* __DEV_SMBUS_SMBCONF_H */
|
