[linux-block.git] / include / linux / pmbus.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Hardware monitoring driver for PMBus devices
 *
 * Copyright (c) 2010, 2011 Ericsson AB.
 */

#ifndef _PMBUS_H_
#define _PMBUS_H_

#include <linux/bits.h>

/* flags */

/*
 * PMBUS_SKIP_STATUS_CHECK
 *
 * During register detection, skip checking the status register for
 * communication or command errors.
 *
 * Some PMBus chips respond with valid data when trying to read an unsupported
 * register. For such chips, checking the status register is mandatory when
 * trying to determine if a chip register exists or not.
 * Other PMBus chips don't support the STATUS_CML register, or report
 * communication errors for no explicable reason. For such chips, checking
 * the status register must be disabled.
 */
#define PMBUS_SKIP_STATUS_CHECK	BIT(0)

/*
 * PMBUS_WRITE_PROTECTED
 * Set if the chip is write protected and write protection is not determined
 * by the standard WRITE_PROTECT command.
 */
#define PMBUS_WRITE_PROTECTED	BIT(1)

/*
 * PMBUS_NO_CAPABILITY
 *
 * Some PMBus chips don't respond with valid data when reading the CAPABILITY
 * register. For such chips, this flag should be set so that the PMBus core
 * driver doesn't use CAPABILITY to determine it's behavior.
 */
#define PMBUS_NO_CAPABILITY			BIT(2)

/*
 * PMBUS_READ_STATUS_AFTER_FAILED_CHECK
 *
 * Some PMBus chips end up in an undefined state when trying to read an
 * unsupported register. For such chips, it is necessary to reset the
 * chip pmbus controller to a known state after a failed register check.
 * This can be done by reading a known register. By setting this flag the
 * driver will try to read the STATUS register after each failed
 * register check. This read may fail, but it will put the chip in a
 * known state.
 */
#define PMBUS_READ_STATUS_AFTER_FAILED_CHECK	BIT(3)

struct pmbus_platform_data {
	u32 flags;		/* Device specific flags */

	/* regulator support */
	int num_regulators;
	struct regulator_init_data *reg_init_data;
};

#endif /* _PMBUS_H_ */
Commit	Line	Data
74ba9207	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
442aba78 GR	2	/*
	3	* Hardware monitoring driver for PMBus devices
	4	*
	5	* Copyright (c) 2010, 2011 Ericsson AB.
442aba78 GR	6	*/
	7
	8	#ifndef _PMBUS_H_
	9	#define _PMBUS_H_
	10
9e347728 GR	11	#include <linux/bits.h>
9e347728 GR	12
442aba78 GR	13	/* flags */
	14
	15	/*
	16	* PMBUS_SKIP_STATUS_CHECK
	17	*
	18	* During register detection, skip checking the status register for
	19	* communication or command errors.
	20	*
	21	* Some PMBus chips respond with valid data when trying to read an unsupported
	22	* register. For such chips, checking the status register is mandatory when
	23	* trying to determine if a chip register exists or not.
	24	* Other PMBus chips don't support the STATUS_CML register, or report
	25	* communication errors for no explicable reason. For such chips, checking
	26	* the status register must be disabled.
	27	*/
9e347728 GR	28	#define PMBUS_SKIP_STATUS_CHECK BIT(0)
	29
	30	/*
	31	* PMBUS_WRITE_PROTECTED
	32	* Set if the chip is write protected and write protection is not determined
	33	* by the standard WRITE_PROTECT command.
	34	*/
	35	#define PMBUS_WRITE_PROTECTED BIT(1)
442aba78	36
e5befc02 EJ	37	/*
	38	* PMBUS_NO_CAPABILITY
	39	*
	40	* Some PMBus chips don't respond with valid data when reading the CAPABILITY
	41	* register. For such chips, this flag should be set so that the PMBus core
	42	* driver doesn't use CAPABILITY to determine it's behavior.
	43	*/
	44	#define PMBUS_NO_CAPABILITY BIT(2)
	45
86c908d9 ER	46	/*
	47	* PMBUS_READ_STATUS_AFTER_FAILED_CHECK
	48	*
	49	* Some PMBus chips end up in an undefined state when trying to read an
	50	* unsupported register. For such chips, it is necessary to reset the
	51	* chip pmbus controller to a known state after a failed register check.
	52	* This can be done by reading a known register. By setting this flag the
	53	* driver will try to read the STATUS register after each failed
	54	* register check. This read may fail, but it will put the chip in a
	55	* known state.
	56	*/
	57	#define PMBUS_READ_STATUS_AFTER_FAILED_CHECK BIT(3)
	58
442aba78 GR	59	struct pmbus_platform_data {
442aba78 GR	60	u32 flags; /* Device specific flags */
ddbb4db4 AT	61
	62	/* regulator support */
	63	int num_regulators;
	64	struct regulator_init_data *reg_init_data;
442aba78 GR	65	};
	66
	67	#endif /* _PMBUS_H_ */