[linux-2.6-block.git] / drivers / i2c / i2c-core.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * i2c-core.h - interfaces internal to the I2C framework
 */

#include <linux/rwsem.h>

struct i2c_devinfo {
	struct list_head	list;
	int			busnum;
	struct i2c_board_info	board_info;
};

/* board_lock protects board_list and first_dynamic_bus_num.
 * only i2c core components are allowed to use these symbols.
 */
extern struct rw_semaphore	__i2c_board_lock;
extern struct list_head	__i2c_board_list;
extern int		__i2c_first_dynamic_bus_num;

int i2c_check_7bit_addr_validity_strict(unsigned short addr);
int i2c_dev_irq_from_resources(const struct resource *resources,
			       unsigned int num_resources);

/*
 * We only allow atomic transfers for very late communication, e.g. to send
 * the powerdown command to a PMIC. Atomic transfers are a corner case and not
 * for generic use!
 */
static inline bool i2c_in_atomic_xfer_mode(void)
{
	return system_state > SYSTEM_RUNNING && irqs_disabled();
}

static inline int __i2c_lock_bus_helper(struct i2c_adapter *adap)
{
	int ret = 0;

	if (i2c_in_atomic_xfer_mode()) {
		WARN(!adap->algo->master_xfer_atomic && !adap->algo->smbus_xfer_atomic,
		     "No atomic I2C transfer handler for '%s'\n", dev_name(&adap->dev));
		ret = i2c_trylock_bus(adap, I2C_LOCK_SEGMENT) ? 0 : -EAGAIN;
	} else {
		i2c_lock_bus(adap, I2C_LOCK_SEGMENT);
	}

	return ret;
}

static inline int __i2c_check_suspended(struct i2c_adapter *adap)
{
	if (test_bit(I2C_ALF_IS_SUSPENDED, &adap->locked_flags)) {
		if (!test_and_set_bit(I2C_ALF_SUSPEND_REPORTED, &adap->locked_flags))
			dev_WARN(&adap->dev, "Transfer while suspended\n");
		return -ESHUTDOWN;
	}

	return 0;
}

#ifdef CONFIG_ACPI
const struct acpi_device_id *
i2c_acpi_match_device(const struct acpi_device_id *matches,
		      struct i2c_client *client);
void i2c_acpi_register_devices(struct i2c_adapter *adap);

int i2c_acpi_get_irq(struct i2c_client *client);
#else /* CONFIG_ACPI */
static inline void i2c_acpi_register_devices(struct i2c_adapter *adap) { }
static inline const struct acpi_device_id *
i2c_acpi_match_device(const struct acpi_device_id *matches,
		      struct i2c_client *client)
{
	return NULL;
}

static inline int i2c_acpi_get_irq(struct i2c_client *client)
{
	return 0;
}
#endif /* CONFIG_ACPI */
extern struct notifier_block i2c_acpi_notifier;

#ifdef CONFIG_ACPI_I2C_OPREGION
int i2c_acpi_install_space_handler(struct i2c_adapter *adapter);
void i2c_acpi_remove_space_handler(struct i2c_adapter *adapter);
#else /* CONFIG_ACPI_I2C_OPREGION */
static inline int i2c_acpi_install_space_handler(struct i2c_adapter *adapter) { return 0; }
static inline void i2c_acpi_remove_space_handler(struct i2c_adapter *adapter) { }
#endif /* CONFIG_ACPI_I2C_OPREGION */

#ifdef CONFIG_OF
void of_i2c_register_devices(struct i2c_adapter *adap);
#else
static inline void of_i2c_register_devices(struct i2c_adapter *adap) { }
#endif
extern struct notifier_block i2c_of_notifier;
Commit	Line	Data
c942fddf	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
9c1600ed DB	2	/*
9c1600ed DB	3	* i2c-core.h - interfaces internal to the I2C framework
9c1600ed DB	4	*/
9c1600ed DB	5
f18c41da RG	6	#include <linux/rwsem.h>
f18c41da RG	7
9c1600ed DB	8	struct i2c_devinfo {
	9	struct list_head list;
	10	int busnum;
	11	struct i2c_board_info board_info;
	12	};
	13
	14	/* board_lock protects board_list and first_dynamic_bus_num.
	15	* only i2c core components are allowed to use these symbols.
	16	*/
f18c41da	17	extern struct rw_semaphore __i2c_board_lock;
9c1600ed DB	18	extern struct list_head __i2c_board_list;
	19	extern int __i2c_first_dynamic_bus_num;
	20
e4991ecd	21	int i2c_check_7bit_addr_validity_strict(unsigned short addr);
1d7534b6 CK	22	int i2c_dev_irq_from_resources(const struct resource *resources,
1d7534b6 CK	23	unsigned int num_resources);
5bf4fa7d	24
bae1d3a0 WS	25	/*
	26	* We only allow atomic transfers for very late communication, e.g. to send
	27	* the powerdown command to a PMIC. Atomic transfers are a corner case and not
	28	* for generic use!
	29	*/
	30	static inline bool i2c_in_atomic_xfer_mode(void)
	31	{
	32	return system_state > SYSTEM_RUNNING && irqs_disabled();
	33	}
	34
83c42212 WS	35	static inline int __i2c_lock_bus_helper(struct i2c_adapter *adap)
	36	{
	37	int ret = 0;
	38
63b96983 WS	39	if (i2c_in_atomic_xfer_mode()) {
	40	WARN(!adap->algo->master_xfer_atomic && !adap->algo->smbus_xfer_atomic,
	41	"No atomic I2C transfer handler for '%s'\n", dev_name(&adap->dev));
83c42212	42	ret = i2c_trylock_bus(adap, I2C_LOCK_SEGMENT) ? 0 : -EAGAIN;
63b96983	43	} else {
83c42212	44	i2c_lock_bus(adap, I2C_LOCK_SEGMENT);
63b96983	45	}
83c42212 WS	46
	47	return ret;
	48	}
	49
5d756112 WS	50	static inline int __i2c_check_suspended(struct i2c_adapter *adap)
	51	{
	52	if (test_bit(I2C_ALF_IS_SUSPENDED, &adap->locked_flags)) {
	53	if (!test_and_set_bit(I2C_ALF_SUSPEND_REPORTED, &adap->locked_flags))
	54	dev_WARN(&adap->dev, "Transfer while suspended\n");
	55	return -ESHUTDOWN;
	56	}
	57
	58	return 0;
	59	}
	60
53f8f7c5	61	#ifdef CONFIG_ACPI
c64ffff7 AS	62	const struct acpi_device_id *
	63	i2c_acpi_match_device(const struct acpi_device_id *matches,
	64	struct i2c_client *client);
53f8f7c5	65	void i2c_acpi_register_devices(struct i2c_adapter *adap);
16c9db1d CK	66
16c9db1d CK	67	int i2c_acpi_get_irq(struct i2c_client *client);
53f8f7c5 WS	68	#else /* CONFIG_ACPI */
53f8f7c5 WS	69	static inline void i2c_acpi_register_devices(struct i2c_adapter *adap) { }
c64ffff7 AS	70	static inline const struct acpi_device_id *
	71	i2c_acpi_match_device(const struct acpi_device_id *matches,
	72	struct i2c_client *client)
	73	{
	74	return NULL;
	75	}
16c9db1d CK	76
	77	static inline int i2c_acpi_get_irq(struct i2c_client *client)
	78	{
	79	return 0;
	80	}
53f8f7c5 WS	81	#endif /* CONFIG_ACPI */
	82	extern struct notifier_block i2c_acpi_notifier;
	83
	84	#ifdef CONFIG_ACPI_I2C_OPREGION
	85	int i2c_acpi_install_space_handler(struct i2c_adapter *adapter);
	86	void i2c_acpi_remove_space_handler(struct i2c_adapter *adapter);
	87	#else /* CONFIG_ACPI_I2C_OPREGION */
	88	static inline int i2c_acpi_install_space_handler(struct i2c_adapter *adapter) { return 0; }
	89	static inline void i2c_acpi_remove_space_handler(struct i2c_adapter *adapter) { }
	90	#endif /* CONFIG_ACPI_I2C_OPREGION */
	91
5bf4fa7d WS	92	#ifdef CONFIG_OF
	93	void of_i2c_register_devices(struct i2c_adapter *adap);
	94	#else
	95	static inline void of_i2c_register_devices(struct i2c_adapter *adap) { }
	96	#endif
	97	extern struct notifier_block i2c_of_notifier;