[linux-2.6-block.git] / drivers / media / tuners / tuner-i2c.h

/*
    tuner-i2c.h - i2c interface for different tuners

    Copyright (C) 2007 Michael Krufky (mkrufky@linuxtv.org)

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef __TUNER_I2C_H__
#define __TUNER_I2C_H__

#include <linux/i2c.h>
#include <linux/slab.h>

struct tuner_i2c_props {
	u8 addr;
	struct i2c_adapter *adap;

	/* used for tuner instance management */
	int count;
	char *name;
};

static inline int tuner_i2c_xfer_send(struct tuner_i2c_props *props,
				      unsigned char *buf, int len)
{
	struct i2c_msg msg = { .addr = props->addr, .flags = 0,
			       .buf = buf, .len = len };
	int ret = i2c_transfer(props->adap, &msg, 1);

	return (ret == 1) ? len : ret;
}

static inline int tuner_i2c_xfer_recv(struct tuner_i2c_props *props,
				      unsigned char *buf, int len)
{
	struct i2c_msg msg = { .addr = props->addr, .flags = I2C_M_RD,
			       .buf = buf, .len = len };
	int ret = i2c_transfer(props->adap, &msg, 1);

	return (ret == 1) ? len : ret;
}

static inline int tuner_i2c_xfer_send_recv(struct tuner_i2c_props *props,
					   unsigned char *obuf, int olen,
					   unsigned char *ibuf, int ilen)
{
	struct i2c_msg msg[2] = { { .addr = props->addr, .flags = 0,
				    .buf = obuf, .len = olen },
				  { .addr = props->addr, .flags = I2C_M_RD,
				    .buf = ibuf, .len = ilen } };
	int ret = i2c_transfer(props->adap, msg, 2);

	return (ret == 2) ? ilen : ret;
}

/* Callers must declare as a global for the module:
 *
 * static LIST_HEAD(hybrid_tuner_instance_list);
 *
 * hybrid_tuner_instance_list should be the third argument
 * passed into hybrid_tuner_request_state().
 *
 * state structure must contain the following:
 *
 *	struct list_head	hybrid_tuner_instance_list;
 *	struct tuner_i2c_props	i2c_props;
 *
 * hybrid_tuner_instance_list (both within state structure and globally)
 * is only required if the driver is using hybrid_tuner_request_state
 * and hybrid_tuner_release_state to manage state sharing between
 * multiple instances of hybrid tuners.
 */

#define tuner_printk(kernlvl, i2cprops, fmt, arg...) do {		\
	printk(kernlvl "%s %d-%04x: " fmt, i2cprops.name,		\
			i2cprops.adap ?					\
				i2c_adapter_id(i2cprops.adap) : -1,	\
			i2cprops.addr, ##arg);				\
	 } while (0)

/* TO DO: convert all callers of these macros to pass in
 * struct tuner_i2c_props, then remove the macro wrappers */

#define __tuner_warn(i2cprops, fmt, arg...) do {			\
	tuner_printk(KERN_WARNING, i2cprops, fmt, ##arg);		\
	} while (0)

#define __tuner_info(i2cprops, fmt, arg...) do {			\
	tuner_printk(KERN_INFO, i2cprops, fmt, ##arg);			\
	} while (0)

#define __tuner_err(i2cprops, fmt, arg...) do {				\
	tuner_printk(KERN_ERR, i2cprops, fmt, ##arg);			\
	} while (0)

#define __tuner_dbg(i2cprops, fmt, arg...) do {				\
	if ((debug))							\
		tuner_printk(KERN_DEBUG, i2cprops, fmt, ##arg);		\
	} while (0)

#define tuner_warn(fmt, arg...) __tuner_warn(priv->i2c_props, fmt, ##arg)
#define tuner_info(fmt, arg...) __tuner_info(priv->i2c_props, fmt, ##arg)
#define tuner_err(fmt, arg...) __tuner_err(priv->i2c_props, fmt, ##arg)
#define tuner_dbg(fmt, arg...) __tuner_dbg(priv->i2c_props, fmt, ##arg)

/****************************************************************************/

/* The return value of hybrid_tuner_request_state indicates the number of
 * instances using this tuner object.
 *
 * 0 - no instances, indicates an error - kzalloc must have failed
 *
 * 1 - one instance, indicates that the tuner object was created successfully
 *
 * 2 (or more) instances, indicates that an existing tuner object was found
 */

#define hybrid_tuner_request_state(type, state, list, i2cadap, i2caddr, devname)\
({									\
	int __ret = 0;							\
	list_for_each_entry(state, &list, hybrid_tuner_instance_list) {	\
		if (((i2cadap) && (state->i2c_props.adap)) &&		\
		    ((i2c_adapter_id(state->i2c_props.adap) ==		\
		      i2c_adapter_id(i2cadap)) &&			\
		     (i2caddr == state->i2c_props.addr))) {		\
			__tuner_info(state->i2c_props,			\
				     "attaching existing instance\n");	\
			state->i2c_props.count++;			\
			__ret = state->i2c_props.count;			\
			break;						\
		}							\
	}								\
	if (0 == __ret) {						\
		state = kzalloc(sizeof(type), GFP_KERNEL);		\
		if (NULL == state)					\
			goto __fail;					\
		state->i2c_props.addr = i2caddr;			\
		state->i2c_props.adap = i2cadap;			\
		state->i2c_props.name = devname;			\
		__tuner_info(state->i2c_props,				\
			     "creating new instance\n");		\
		list_add_tail(&state->hybrid_tuner_instance_list, &list);\
		state->i2c_props.count++;				\
		__ret = state->i2c_props.count;				\
	}								\
__fail:									\
	__ret;								\
})

#define hybrid_tuner_release_state(state)				\
({									\
	int __ret;							\
	state->i2c_props.count--;					\
	__ret = state->i2c_props.count;					\
	if (!state->i2c_props.count) {					\
		__tuner_info(state->i2c_props, "destroying instance\n");\
		list_del(&state->hybrid_tuner_instance_list);		\
		kfree(state);						\
	}								\
	__ret;								\
})

#define hybrid_tuner_report_instance_count(state)			\
({									\
	int __ret = 0;							\
	if (state)							\
		__ret = state->i2c_props.count;				\
	__ret;								\
})

#endif /* __TUNER_I2C_H__ */
Commit	Line	Data
db8a6956 MK	1	/*
	2	tuner-i2c.h - i2c interface for different tuners
	3
	4	Copyright (C) 2007 Michael Krufky (mkrufky@linuxtv.org)
	5
	6	This program is free software; you can redistribute it and/or modify
	7	it under the terms of the GNU General Public License as published by
	8	the Free Software Foundation; either version 2 of the License, or
	9	(at your option) any later version.
	10
	11	This program is distributed in the hope that it will be useful,
	12	but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	GNU General Public License for more details.
	15
	16	You should have received a copy of the GNU General Public License
	17	along with this program; if not, write to the Free Software
	18	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	19	*/
	20
	21	#ifndef __TUNER_I2C_H__
	22	#define __TUNER_I2C_H__
	23
	24	#include <linux/i2c.h>
5a0e3ad6	25	#include <linux/slab.h>
db8a6956 MK	26
	27	struct tuner_i2c_props {
	28	u8 addr;
	29	struct i2c_adapter *adap;
3c2a0865 MK	30
	31	/* used for tuner instance management */
	32	int count;
	33	char *name;
db8a6956 MK	34	};
db8a6956 MK	35
ceefaf5d MCC	36	static inline int tuner_i2c_xfer_send(struct tuner_i2c_props *props,
ceefaf5d MCC	37	unsigned char *buf, int len)
db8a6956 MK	38	{
	39	struct i2c_msg msg = { .addr = props->addr, .flags = 0,
	40	.buf = buf, .len = len };
	41	int ret = i2c_transfer(props->adap, &msg, 1);
	42
	43	return (ret == 1) ? len : ret;
	44	}
	45
ceefaf5d MCC	46	static inline int tuner_i2c_xfer_recv(struct tuner_i2c_props *props,
ceefaf5d MCC	47	unsigned char *buf, int len)
db8a6956 MK	48	{
	49	struct i2c_msg msg = { .addr = props->addr, .flags = I2C_M_RD,
	50	.buf = buf, .len = len };
	51	int ret = i2c_transfer(props->adap, &msg, 1);
	52
	53	return (ret == 1) ? len : ret;
	54	}
	55
7d58d111	56	static inline int tuner_i2c_xfer_send_recv(struct tuner_i2c_props *props,
ceefaf5d MCC	57	unsigned char *obuf, int olen,
ceefaf5d MCC	58	unsigned char *ibuf, int ilen)
7d58d111 CP	59	{
	60	struct i2c_msg msg[2] = { { .addr = props->addr, .flags = 0,
	61	.buf = obuf, .len = olen },
	62	{ .addr = props->addr, .flags = I2C_M_RD,
	63	.buf = ibuf, .len = ilen } };
	64	int ret = i2c_transfer(props->adap, msg, 2);
	65
	66	return (ret == 2) ? ilen : ret;
	67	}
	68
3c2a0865 MK	69	/* Callers must declare as a global for the module:
	70	*
	71	* static LIST_HEAD(hybrid_tuner_instance_list);
	72	*
	73	* hybrid_tuner_instance_list should be the third argument
	74	* passed into hybrid_tuner_request_state().
	75	*
	76	* state structure must contain the following:
	77	*
4a3fad70	78	* struct list_head hybrid_tuner_instance_list;
3c2a0865 MK	79	* struct tuner_i2c_props i2c_props;
	80	*
	81	* hybrid_tuner_instance_list (both within state structure and globally)
	82	* is only required if the driver is using hybrid_tuner_request_state
	83	* and hybrid_tuner_release_state to manage state sharing between
	84	* multiple instances of hybrid tuners.
	85	*/
	86
	87	#define tuner_printk(kernlvl, i2cprops, fmt, arg...) do { \
	88	printk(kernlvl "%s %d-%04x: " fmt, i2cprops.name, \
ab6c46e2 MK	89	i2cprops.adap ? \
ab6c46e2 MK	90	i2c_adapter_id(i2cprops.adap) : -1, \
3c2a0865	91	i2cprops.addr, ##arg); \
98883cdc MCC	92	} while (0)
98883cdc MCC	93
3c2a0865 MK	94	/* TO DO: convert all callers of these macros to pass in
	95	* struct tuner_i2c_props, then remove the macro wrappers */
	96
	97	#define __tuner_warn(i2cprops, fmt, arg...) do { \
	98	tuner_printk(KERN_WARNING, i2cprops, fmt, ##arg); \
98883cdc MCC	99	} while (0)
98883cdc MCC	100
3c2a0865 MK	101	#define __tuner_info(i2cprops, fmt, arg...) do { \
3c2a0865 MK	102	tuner_printk(KERN_INFO, i2cprops, fmt, ##arg); \
98883cdc MCC	103	} while (0)
98883cdc MCC	104
3c2a0865 MK	105	#define __tuner_err(i2cprops, fmt, arg...) do { \
	106	tuner_printk(KERN_ERR, i2cprops, fmt, ##arg); \
	107	} while (0)
	108
	109	#define __tuner_dbg(i2cprops, fmt, arg...) do { \
98883cdc	110	if ((debug)) \
3c2a0865	111	tuner_printk(KERN_DEBUG, i2cprops, fmt, ##arg); \
98883cdc	112	} while (0)
db8a6956	113
3c2a0865 MK	114	#define tuner_warn(fmt, arg...) __tuner_warn(priv->i2c_props, fmt, ##arg)
	115	#define tuner_info(fmt, arg...) __tuner_info(priv->i2c_props, fmt, ##arg)
	116	#define tuner_err(fmt, arg...) __tuner_err(priv->i2c_props, fmt, ##arg)
	117	#define tuner_dbg(fmt, arg...) __tuner_dbg(priv->i2c_props, fmt, ##arg)
	118
	119	/****************************************************************************/
	120
	121	/* The return value of hybrid_tuner_request_state indicates the number of
	122	* instances using this tuner object.
	123	*
	124	* 0 - no instances, indicates an error - kzalloc must have failed
	125	*
	126	* 1 - one instance, indicates that the tuner object was created successfully
	127	*
	128	* 2 (or more) instances, indicates that an existing tuner object was found
	129	*/
	130
	131	#define hybrid_tuner_request_state(type, state, list, i2cadap, i2caddr, devname)\
	132	({ \
	133	int __ret = 0; \
	134	list_for_each_entry(state, &list, hybrid_tuner_instance_list) { \
cac2b0eb MK	135	if (((i2cadap) && (state->i2c_props.adap)) && \
	136	((i2c_adapter_id(state->i2c_props.adap) == \
	137	i2c_adapter_id(i2cadap)) && \
	138	(i2caddr == state->i2c_props.addr))) { \
3c2a0865 MK	139	__tuner_info(state->i2c_props, \
	140	"attaching existing instance\n"); \
	141	state->i2c_props.count++; \
	142	__ret = state->i2c_props.count; \
	143	break; \
	144	} \
	145	} \
	146	if (0 == __ret) { \
	147	state = kzalloc(sizeof(type), GFP_KERNEL); \
	148	if (NULL == state) \
	149	goto __fail; \
	150	state->i2c_props.addr = i2caddr; \
	151	state->i2c_props.adap = i2cadap; \
	152	state->i2c_props.name = devname; \
	153	__tuner_info(state->i2c_props, \
	154	"creating new instance\n"); \
	155	list_add_tail(&state->hybrid_tuner_instance_list, &list);\
	156	state->i2c_props.count++; \
	157	__ret = state->i2c_props.count; \
	158	} \
	159	__fail: \
	160	__ret; \
	161	})
	162
c1b4d927 MK	163	#define hybrid_tuner_release_state(state) \
	164	({ \
	165	int __ret; \
3c2a0865	166	state->i2c_props.count--; \
c1b4d927	167	__ret = state->i2c_props.count; \
3c2a0865 MK	168	if (!state->i2c_props.count) { \
	169	__tuner_info(state->i2c_props, "destroying instance\n");\
	170	list_del(&state->hybrid_tuner_instance_list); \
	171	kfree(state); \
	172	} \
c1b4d927 MK	173	__ret; \
c1b4d927 MK	174	})
3c2a0865	175
9adea1c0 MK	176	#define hybrid_tuner_report_instance_count(state) \
	177	({ \
	178	int __ret = 0; \
	179	if (state) \
	180	__ret = state->i2c_props.count; \
	181	__ret; \
	182	})
	183
db8a6956	184	#endif /* __TUNER_I2C_H__ */