Kernel/linux
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2025-01-16 18:08:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

i2c: isch: Convert to kernel-doc

Browse Source 
Convert existing descriptions to kernel-doc format and unify
the rest of the comments to follow the modern style.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Signed-off-by: Andi Shyti <andi.shyti@kernel.org>
This commit is contained in:
Andy Shevchenko 2024-09-16 15:01:38 +03:00 committed by Andi Shyti
parent e1d9e16c39
commit 71754212c0
1 changed files with 28 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
drivers/i2c/busses/i2c-isch.c
View File

@ -1,13 +1,12 @@
// SPDX-License-Identifier: GPL-2.0-only // SPDX-License-Identifier: GPL-2.0-only
/* /*
i2c-isch.c - Linux kernel driver for Intel SCH chipset SMBus * Linux kernel driver for Intel SCH chipset SMBus
- Based on i2c-piix4.c * - Based on i2c-piix4.c
Copyright (c) 1998 - 2002 Frodo Looijaard <frodol@dds.nl> and * Copyright (c) 1998 - 2002 Frodo Looijaard <frodol@dds.nl> and
Philip Edelbrock <phil@netroedge.com> * Philip Edelbrock <phil@netroedge.com>
- Intel SCH support * - Intel SCH support
Copyright (c) 2007 - 2008 Jacob Jun Pan <jacob.jun.pan@intel.com> * Copyright (c) 2007 - 2008 Jacob Jun Pan <jacob.jun.pan@intel.com>
*/
*/
/* Supports: Intel SCH chipsets (AF82US15W, AF82US15L, AF82UL11L) */ /* Supports: Intel SCH chipsets (AF82US15W, AF82US15L, AF82UL11L) */
@ -72,10 +71,14 @@ static inline void sch_io_wr16(struct sch_i2c *priv, unsigned int offset, u16 va
iowrite16(value, priv->smba + offset); iowrite16(value, priv->smba + offset);
} }
/* /**
* Start the i2c transaction -- the i2c_access will prepare the transaction * sch_transaction - Start the i2c transaction
* and this function will execute it. * @adap: the i2c adapter pointer
* return 0 for success and others for failure. *
* The sch_access() will prepare the transaction and
* this function will execute it.
*
* Return: 0 for success and others for failure.
*/ */
static int sch_transaction(struct i2c_adapter *adap) static int sch_transaction(struct i2c_adapter *adap)
{ {
@ -105,7 +108,7 @@ static int sch_transaction(struct i2c_adapter *adap)
} }
} }
/* start the transaction by setting bit 4 */ /* Start the transaction by setting bit 4 */
temp = sch_io_rd8(priv, SMBHSTCNT); temp = sch_io_rd8(priv, SMBHSTCNT);
temp |= 0x10; temp |= 0x10;
sch_io_wr8(priv, SMBHSTCNT, temp); sch_io_wr8(priv, SMBHSTCNT, temp);
@ -141,12 +144,17 @@ static int sch_transaction(struct i2c_adapter *adap)
return rc; return rc;
} }
/* /**
* This is the main access entry for i2c-sch access * sch_access - the main access entry for i2c-sch access
* adap is i2c_adapter pointer, addr is the i2c device bus address, read_write * @adap: the i2c adapter pointer
* (0 for read and 1 for write), size is i2c transaction type and data is the * @addr: the i2c device bus address
* union of transaction for data to be transferred or data read from bus. * @flags: I2C_CLIENT_* flags (usually zero or I2C_CLIENT_PEC)
* return 0 for success and others for failure. * @read_write: 0 for read and 1 for write
* @command: Byte interpreted by slave, for protocols which use such bytes
* @size: the i2c transaction type
* @data: the union of transaction for data to be transferred or data read from bus
*
* Return: 0 for success and others for failure.
*/ */
static s32 sch_access(struct i2c_adapter *adap, u16 addr, static s32 sch_access(struct i2c_adapter *adap, u16 addr,
unsigned short flags, char read_write, unsigned short flags, char read_write,
@ -281,7 +289,7 @@ static int smbus_sch_probe(struct platform_device *pdev)
if (!priv->smba) if (!priv->smba)
return dev_err_probe(dev, -EBUSY, "SMBus region %pR already in use!\n", res); return dev_err_probe(dev, -EBUSY, "SMBus region %pR already in use!\n", res);
/* set up the sysfs linkage to our parent device */ /* Set up the sysfs linkage to our parent device */
priv->adapter.dev.parent = dev; priv->adapter.dev.parent = dev;
priv->adapter.owner = THIS_MODULE, priv->adapter.owner = THIS_MODULE,
priv->adapter.class = I2C_CLASS_HWMON, priv->adapter.class = I2C_CLASS_HWMON,