[deliverable/linux.git] / drivers / media / usb / pvrusb2 / pvrusb2-hdw.h

/*
 *
 *
 *  Copyright (C) 2005 Mike Isely <isely@pobox.com>
 *
 *  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
 *
 *  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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
#ifndef __PVRUSB2_HDW_H
#define __PVRUSB2_HDW_H

#include <linux/usb.h>
#include <linux/videodev2.h>
#include <media/v4l2-dev.h>
#include "pvrusb2-io.h"
#include "pvrusb2-ctrl.h"


/* Private internal control ids, look these up with
   pvr2_hdw_get_ctrl_by_id() - these are NOT visible in V4L */
#define PVR2_CID_STDCUR 2
#define PVR2_CID_STDAVAIL 3
#define PVR2_CID_INPUT 4
#define PVR2_CID_AUDIOMODE 5
#define PVR2_CID_FREQUENCY 6
#define PVR2_CID_HRES 7
#define PVR2_CID_VRES 8
#define PVR2_CID_CROPL 9
#define PVR2_CID_CROPT 10
#define PVR2_CID_CROPW 11
#define PVR2_CID_CROPH 12
#define PVR2_CID_CROPCAPPAN 13
#define PVR2_CID_CROPCAPPAD 14
#define PVR2_CID_CROPCAPBL 15
#define PVR2_CID_CROPCAPBT 16
#define PVR2_CID_CROPCAPBW 17
#define PVR2_CID_CROPCAPBH 18
#define PVR2_CID_STDDETECT 19

/* Legal values for the INPUT state variable */
#define PVR2_CVAL_INPUT_TV 0
#define PVR2_CVAL_INPUT_DTV 1
#define PVR2_CVAL_INPUT_COMPOSITE 2
#define PVR2_CVAL_INPUT_SVIDEO 3
#define PVR2_CVAL_INPUT_RADIO 4

enum pvr2_config {
	pvr2_config_empty,    /* No configuration */
	pvr2_config_mpeg,     /* Encoded / compressed video */
	pvr2_config_vbi,      /* Standard vbi info */
	pvr2_config_pcm,      /* Audio raw pcm stream */
	pvr2_config_rawvideo, /* Video raw frames */
};

enum pvr2_v4l_type {
	pvr2_v4l_type_video,
	pvr2_v4l_type_vbi,
	pvr2_v4l_type_radio,
};

/* Major states that we can be in:
 *
 *  DEAD - Device is in an unusable state and cannot be recovered.  This
 *  can happen if we completely lose the ability to communicate with it
 *  (but it might still on the bus).  In this state there's nothing we can
 *  do; it must be replugged in order to recover.
 *
 *  COLD - Device is in an unusable state, needs microcontroller firmware.
 *
 *  WARM - We can communicate with the device and the proper
 *  microcontroller firmware is running, but other device initialization is
 *  still needed (e.g. encoder firmware).
 *
 *  ERROR - A problem prevents capture operation (e.g. encoder firmware
 *  missing).
 *
 *  READY - Device is operational, but not streaming.
 *
 *  RUN - Device is streaming.
 *
 */
#define PVR2_STATE_NONE 0
#define PVR2_STATE_DEAD 1
#define PVR2_STATE_COLD 2
#define PVR2_STATE_WARM 3
#define PVR2_STATE_ERROR 4
#define PVR2_STATE_READY 5
#define PVR2_STATE_RUN 6

/* Translate configuration enum to a string label */
const char *pvr2_config_get_name(enum pvr2_config);

struct pvr2_hdw;

/* Create and return a structure for interacting with the underlying
   hardware */
struct pvr2_hdw *pvr2_hdw_create(struct usb_interface *intf,
				 const struct usb_device_id *devid);

/* Perform second stage initialization, passing in a notification callback
   for when the master state changes. */
int pvr2_hdw_initialize(struct pvr2_hdw *,
			void (*callback_func)(void *),
			void *callback_data);

/* Destroy hardware interaction structure */
void pvr2_hdw_destroy(struct pvr2_hdw *);

/* Return true if in the ready (normal) state */
int pvr2_hdw_dev_ok(struct pvr2_hdw *);

/* Return small integer number [1..N] for logical instance number of this
   device.  This is useful for indexing array-valued module parameters. */
int pvr2_hdw_get_unit_number(struct pvr2_hdw *);

/* Get pointer to underlying USB device */
struct usb_device *pvr2_hdw_get_dev(struct pvr2_hdw *);

/* Retrieve serial number of device */
unsigned long pvr2_hdw_get_sn(struct pvr2_hdw *);

/* Retrieve bus location info of device */
const char *pvr2_hdw_get_bus_info(struct pvr2_hdw *);

/* Retrieve per-instance string identifier for this specific device */
const char *pvr2_hdw_get_device_identifier(struct pvr2_hdw *);

/* Called when hardware has been unplugged */
void pvr2_hdw_disconnect(struct pvr2_hdw *);

/* Sets v4l2_dev of a video_device struct */
void pvr2_hdw_set_v4l2_dev(struct pvr2_hdw *, struct video_device *);

/* Get the number of defined controls */
unsigned int pvr2_hdw_get_ctrl_count(struct pvr2_hdw *);

/* Retrieve a control handle given its index (0..count-1) */
struct pvr2_ctrl *pvr2_hdw_get_ctrl_by_index(struct pvr2_hdw *,unsigned int);

/* Retrieve a control handle given its internal ID (if any) */
struct pvr2_ctrl *pvr2_hdw_get_ctrl_by_id(struct pvr2_hdw *,unsigned int);

/* Retrieve a control handle given its V4L ID (if any) */
struct pvr2_ctrl *pvr2_hdw_get_ctrl_v4l(struct pvr2_hdw *,unsigned int ctl_id);

/* Retrieve a control handle given its immediate predecessor V4L ID (if any) */
struct pvr2_ctrl *pvr2_hdw_get_ctrl_nextv4l(struct pvr2_hdw *,
					    unsigned int ctl_id);

/* Commit all control changes made up to this point */
int pvr2_hdw_commit_ctl(struct pvr2_hdw *);

/* Return a bit mask of valid input selections for this device.  Mask bits
 * will be according to PVR_CVAL_INPUT_xxxx definitions. */
unsigned int pvr2_hdw_get_input_available(struct pvr2_hdw *);

/* Return a bit mask of allowed input selections for this device.  Mask bits
 * will be according to PVR_CVAL_INPUT_xxxx definitions. */
unsigned int pvr2_hdw_get_input_allowed(struct pvr2_hdw *);

/* Change the set of allowed input selections for this device.  Both
   change_mask and change_valu are mask bits according to
   PVR_CVAL_INPUT_xxxx definitions.  The change_mask parameter indicate
   which settings are being changed and the change_val parameter indicates
   whether corresponding settings are being set or cleared. */
int pvr2_hdw_set_input_allowed(struct pvr2_hdw *,
			       unsigned int change_mask,
			       unsigned int change_val);

/* Return name for this driver instance */
const char *pvr2_hdw_get_driver_name(struct pvr2_hdw *);

/* Mark tuner status stale so that it will be re-fetched */
void pvr2_hdw_execute_tuner_poll(struct pvr2_hdw *);

/* Return information about the tuner */
int pvr2_hdw_get_tuner_status(struct pvr2_hdw *,struct v4l2_tuner *);

/* Return information about cropping capabilities */
int pvr2_hdw_get_cropcap(struct pvr2_hdw *, struct v4l2_cropcap *);

/* Query device and see if it thinks it is on a high-speed USB link */
int pvr2_hdw_is_hsm(struct pvr2_hdw *);

/* Return a string token representative of the hardware type */
const char *pvr2_hdw_get_type(struct pvr2_hdw *);

/* Return a single line description of the hardware type */
const char *pvr2_hdw_get_desc(struct pvr2_hdw *);

/* Turn streaming on/off */
int pvr2_hdw_set_streaming(struct pvr2_hdw *,int);

/* Find out if streaming is on */
int pvr2_hdw_get_streaming(struct pvr2_hdw *);

/* Retrieve driver overall state */
int pvr2_hdw_get_state(struct pvr2_hdw *);

/* Configure the type of stream to generate */
int pvr2_hdw_set_stream_type(struct pvr2_hdw *, enum pvr2_config);

/* Get handle to video output stream */
struct pvr2_stream *pvr2_hdw_get_video_stream(struct pvr2_hdw *);

/* Enable / disable retrieval of CPU firmware or prom contents.  This must
   be enabled before pvr2_hdw_cpufw_get() will function.  Note that doing
   this may prevent the device from running (and leaving this mode may
   imply a device reset). */
void pvr2_hdw_cpufw_set_enabled(struct pvr2_hdw *,
				int mode, /* 0=8KB FX2, 1=16KB FX2, 2=PROM */
				int enable_flag);

/* Return true if we're in a mode for retrieval CPU firmware */
int pvr2_hdw_cpufw_get_enabled(struct pvr2_hdw *);

/* Retrieve a piece of the CPU's firmware at the given offset.  Return
   value is the number of bytes retrieved or zero if we're past the end or
   an error otherwise (e.g. if firmware retrieval is not enabled). */
int pvr2_hdw_cpufw_get(struct pvr2_hdw *,unsigned int offs,
		       char *buf,unsigned int cnt);

/* Retrieve a previously stored v4l minor device number */
int pvr2_hdw_v4l_get_minor_number(struct pvr2_hdw *,enum pvr2_v4l_type index);

/* Store a v4l minor device number */
void pvr2_hdw_v4l_store_minor_number(struct pvr2_hdw *,
				     enum pvr2_v4l_type index,int);

/* The following entry points are all lower level things you normally don't
   want to worry about. */

/* Issue a command and get a response from the device.  LOTS of higher
   level stuff is built on this. */
int pvr2_send_request(struct pvr2_hdw *,
		      void *write_ptr,unsigned int write_len,
		      void *read_ptr,unsigned int read_len);

/* Slightly higher level device communication functions. */
int pvr2_write_register(struct pvr2_hdw *, u16, u32);

/* Call if for any reason we can't talk to the hardware anymore - this will
   cause the driver to stop flailing on the device. */
void pvr2_hdw_render_useless(struct pvr2_hdw *);

/* Set / clear 8051's reset bit */
void pvr2_hdw_cpureset_assert(struct pvr2_hdw *,int);

/* Execute a USB-commanded device reset */
void pvr2_hdw_device_reset(struct pvr2_hdw *);

/* Reset worker's error trapping circuit breaker */
int pvr2_hdw_untrip(struct pvr2_hdw *);

/* Execute hard reset command (after this point it's likely that the
   encoder will have to be reconfigured).  This also clears the "useless"
   state. */
int pvr2_hdw_cmd_deep_reset(struct pvr2_hdw *);

/* Execute simple reset command */
int pvr2_hdw_cmd_powerup(struct pvr2_hdw *);

/* suspend */
int pvr2_hdw_cmd_powerdown(struct pvr2_hdw *);

/* Order decoder to reset */
int pvr2_hdw_cmd_decoder_reset(struct pvr2_hdw *);

/* Direct manipulation of GPIO bits */
int pvr2_hdw_gpio_get_dir(struct pvr2_hdw *hdw,u32 *);
int pvr2_hdw_gpio_get_out(struct pvr2_hdw *hdw,u32 *);
int pvr2_hdw_gpio_get_in(struct pvr2_hdw *hdw,u32 *);
int pvr2_hdw_gpio_chg_dir(struct pvr2_hdw *hdw,u32 msk,u32 val);
int pvr2_hdw_gpio_chg_out(struct pvr2_hdw *hdw,u32 msk,u32 val);

/* This data structure is specifically for the next function... */
struct pvr2_hdw_debug_info {
	int big_lock_held;
	int ctl_lock_held;
	int flag_disconnected;
	int flag_init_ok;
	int flag_ok;
	int fw1_state;
	int flag_decoder_missed;
	int flag_tripped;
	int state_encoder_ok;
	int state_encoder_run;
	int state_decoder_run;
	int state_decoder_ready;
	int state_usbstream_run;
	int state_decoder_quiescent;
	int state_pipeline_config;
	int state_pipeline_req;
	int state_pipeline_pause;
	int state_pipeline_idle;
	int cmd_debug_state;
	int cmd_debug_write_len;
	int cmd_debug_read_len;
	int cmd_debug_write_pend;
	int cmd_debug_read_pend;
	int cmd_debug_timeout;
	int cmd_debug_rstatus;
	int cmd_debug_wstatus;
	unsigned char cmd_code;
};

/* Non-intrusively retrieve internal state info - this is useful for
   diagnosing lockups.  Note that this operation is completed without any
   kind of locking and so it is not atomic and may yield inconsistent
   results.  This is *purely* a debugging aid. */
void pvr2_hdw_get_debug_info_unlocked(const struct pvr2_hdw *hdw,
				      struct pvr2_hdw_debug_info *);

/* Intrusively retrieve internal state info - this is useful for
   diagnosing overall driver state.  This operation synchronizes against
   the overall driver mutex - so if there are locking problems this will
   likely hang!  This is *purely* a debugging aid. */
void pvr2_hdw_get_debug_info_locked(struct pvr2_hdw *hdw,
				    struct pvr2_hdw_debug_info *);

/* Report out several lines of text that describes driver internal state.
   Results are written into the passed-in buffer. */
unsigned int pvr2_hdw_state_report(struct pvr2_hdw *hdw,
				   char *buf_ptr,unsigned int buf_size);

/* Cause modules to log their state once */
void pvr2_hdw_trigger_module_log(struct pvr2_hdw *hdw);

/* Cause encoder firmware to be uploaded into the device.  This is normally
   done autonomously, but the interface is exported here because it is also
   a debugging aid. */
int pvr2_upload_firmware2(struct pvr2_hdw *hdw);

#endif /* __PVRUSB2_HDW_H */
Commit	Line	Data
d855497e MI	1	/*
d855497e MI	2	*
d855497e MI	3	*
	4	* Copyright (C) 2005 Mike Isely <isely@pobox.com>
	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
	9	*
	10	* This program is distributed in the hope that it will be useful,
	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	* GNU General Public License for more details.
	14	*
	15	* You should have received a copy of the GNU General Public License
	16	* along with this program; if not, write to the Free Software
	17	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	18	*
	19	*/
	20	#ifndef __PVRUSB2_HDW_H
	21	#define __PVRUSB2_HDW_H
	22
	23	#include <linux/usb.h>
	24	#include <linux/videodev2.h>
a28fbd04	25	#include <media/v4l2-dev.h>
d855497e MI	26	#include "pvrusb2-io.h"
	27	#include "pvrusb2-ctrl.h"
	28
d855497e MI	29
	30	/* Private internal control ids, look these up with
	31	pvr2_hdw_get_ctrl_by_id() - these are NOT visible in V4L */
d855497e MI	32	#define PVR2_CID_STDCUR 2
	33	#define PVR2_CID_STDAVAIL 3
	34	#define PVR2_CID_INPUT 4
	35	#define PVR2_CID_AUDIOMODE 5
	36	#define PVR2_CID_FREQUENCY 6
	37	#define PVR2_CID_HRES 7
	38	#define PVR2_CID_VRES 8
e784bfb9	39	#define PVR2_CID_CROPL 9
	40	#define PVR2_CID_CROPT 10
	41	#define PVR2_CID_CROPW 11
	42	#define PVR2_CID_CROPH 12
432907f7 MI	43	#define PVR2_CID_CROPCAPPAN 13
	44	#define PVR2_CID_CROPCAPPAD 14
	45	#define PVR2_CID_CROPCAPBL 15
	46	#define PVR2_CID_CROPCAPBT 16
	47	#define PVR2_CID_CROPCAPBW 17
	48	#define PVR2_CID_CROPCAPBH 18
ac04d00e	49	#define PVR2_CID_STDDETECT 19
d855497e MI	50
	51	/* Legal values for the INPUT state variable */
	52	#define PVR2_CVAL_INPUT_TV 0
29bf5b1d	53	#define PVR2_CVAL_INPUT_DTV 1
dbc40a0e MI	54	#define PVR2_CVAL_INPUT_COMPOSITE 2
dbc40a0e MI	55	#define PVR2_CVAL_INPUT_SVIDEO 3
29bf5b1d	56	#define PVR2_CVAL_INPUT_RADIO 4
d855497e	57
d855497e	58	enum pvr2_config {
16eb40d3 MI	59	pvr2_config_empty, /* No configuration */
	60	pvr2_config_mpeg, /* Encoded / compressed video */
	61	pvr2_config_vbi, /* Standard vbi info */
	62	pvr2_config_pcm, /* Audio raw pcm stream */
	63	pvr2_config_rawvideo, /* Video raw frames */
d855497e MI	64	};
d855497e MI	65
8079384e MI	66	enum pvr2_v4l_type {
	67	pvr2_v4l_type_video,
	68	pvr2_v4l_type_vbi,
	69	pvr2_v4l_type_radio,
	70	};
	71
681c7399 MI	72	/* Major states that we can be in:
	73	*
	74	* DEAD - Device is in an unusable state and cannot be recovered. This
	75	* can happen if we completely lose the ability to communicate with it
	76	* (but it might still on the bus). In this state there's nothing we can
	77	* do; it must be replugged in order to recover.
	78	*
25985edc	79	* COLD - Device is in an unusable state, needs microcontroller firmware.
681c7399 MI	80	*
	81	* WARM - We can communicate with the device and the proper
	82	* microcontroller firmware is running, but other device initialization is
	83	* still needed (e.g. encoder firmware).
	84	*
	85	* ERROR - A problem prevents capture operation (e.g. encoder firmware
	86	* missing).
	87	*
	88	* READY - Device is operational, but not streaming.
	89	*
	90	* RUN - Device is streaming.
	91	*
	92	*/
	93	#define PVR2_STATE_NONE 0
	94	#define PVR2_STATE_DEAD 1
	95	#define PVR2_STATE_COLD 2
	96	#define PVR2_STATE_WARM 3
	97	#define PVR2_STATE_ERROR 4
	98	#define PVR2_STATE_READY 5
	99	#define PVR2_STATE_RUN 6
	100
	101	/* Translate configuration enum to a string label */
d855497e MI	102	const char *pvr2_config_get_name(enum pvr2_config);
	103
	104	struct pvr2_hdw;
	105
	106	/* Create and return a structure for interacting with the underlying
	107	hardware */
	108	struct pvr2_hdw pvr2_hdw_create(struct usb_interface intf,
	109	const struct usb_device_id *devid);
	110
c4a8828d MI	111	/* Perform second stage initialization, passing in a notification callback
c4a8828d MI	112	for when the master state changes. */
794b1607 MI	113	int pvr2_hdw_initialize(struct pvr2_hdw *,
	114	void (callback_func)(void ),
	115	void *callback_data);
c4a8828d	116
d855497e MI	117	/* Destroy hardware interaction structure */
	118	void pvr2_hdw_destroy(struct pvr2_hdw *);
	119
d855497e MI	120	/* Return true if in the ready (normal) state */
	121	int pvr2_hdw_dev_ok(struct pvr2_hdw *);
	122
	123	/* Return small integer number [1..N] for logical instance number of this
	124	device. This is useful for indexing array-valued module parameters. */
	125	int pvr2_hdw_get_unit_number(struct pvr2_hdw *);
	126
	127	/* Get pointer to underlying USB device */
	128	struct usb_device pvr2_hdw_get_dev(struct pvr2_hdw );
	129
	130	/* Retrieve serial number of device */
	131	unsigned long pvr2_hdw_get_sn(struct pvr2_hdw *);
	132
31a18547 MI	133	/* Retrieve bus location info of device */
	134	const char pvr2_hdw_get_bus_info(struct pvr2_hdw );
	135
13a88797 MI	136	/* Retrieve per-instance string identifier for this specific device */
	137	const char pvr2_hdw_get_device_identifier(struct pvr2_hdw );
	138
d855497e MI	139	/* Called when hardware has been unplugged */
	140	void pvr2_hdw_disconnect(struct pvr2_hdw *);
	141
a28fbd04 HV	142	/* Sets v4l2_dev of a video_device struct */
	143	void pvr2_hdw_set_v4l2_dev(struct pvr2_hdw , struct video_device );
	144
d855497e MI	145	/* Get the number of defined controls */
	146	unsigned int pvr2_hdw_get_ctrl_count(struct pvr2_hdw *);
	147
	148	/* Retrieve a control handle given its index (0..count-1) */
	149	struct pvr2_ctrl pvr2_hdw_get_ctrl_by_index(struct pvr2_hdw ,unsigned int);
	150
	151	/* Retrieve a control handle given its internal ID (if any) */
	152	struct pvr2_ctrl pvr2_hdw_get_ctrl_by_id(struct pvr2_hdw ,unsigned int);
	153
	154	/* Retrieve a control handle given its V4L ID (if any) */
	155	struct pvr2_ctrl pvr2_hdw_get_ctrl_v4l(struct pvr2_hdw ,unsigned int ctl_id);
	156
a761f431 MI	157	/* Retrieve a control handle given its immediate predecessor V4L ID (if any) */
	158	struct pvr2_ctrl pvr2_hdw_get_ctrl_nextv4l(struct pvr2_hdw ,
	159	unsigned int ctl_id);
	160
d855497e MI	161	/* Commit all control changes made up to this point */
	162	int pvr2_hdw_commit_ctl(struct pvr2_hdw *);
	163
7fb20fa3 MI	164	/* Return a bit mask of valid input selections for this device. Mask bits
	165	* will be according to PVR_CVAL_INPUT_xxxx definitions. */
	166	unsigned int pvr2_hdw_get_input_available(struct pvr2_hdw *);
	167
1cb03b76 MI	168	/* Return a bit mask of allowed input selections for this device. Mask bits
	169	* will be according to PVR_CVAL_INPUT_xxxx definitions. */
	170	unsigned int pvr2_hdw_get_input_allowed(struct pvr2_hdw *);
	171
	172	/* Change the set of allowed input selections for this device. Both
	173	change_mask and change_valu are mask bits according to
	174	PVR_CVAL_INPUT_xxxx definitions. The change_mask parameter indicate
	175	which settings are being changed and the change_val parameter indicates
	176	whether corresponding settings are being set or cleared. */
	177	int pvr2_hdw_set_input_allowed(struct pvr2_hdw *,
	178	unsigned int change_mask,
	179	unsigned int change_val);
	180
d855497e MI	181	/* Return name for this driver instance */
	182	const char pvr2_hdw_get_driver_name(struct pvr2_hdw );
	183
18103c57 MI	184	/* Mark tuner status stale so that it will be re-fetched */
	185	void pvr2_hdw_execute_tuner_poll(struct pvr2_hdw *);
	186
	187	/* Return information about the tuner */
	188	int pvr2_hdw_get_tuner_status(struct pvr2_hdw ,struct v4l2_tuner );
d855497e	189
432907f7 MI	190	/* Return information about cropping capabilities */
	191	int pvr2_hdw_get_cropcap(struct pvr2_hdw , struct v4l2_cropcap );
	192
d855497e MI	193	/* Query device and see if it thinks it is on a high-speed USB link */
	194	int pvr2_hdw_is_hsm(struct pvr2_hdw *);
	195
78a47101 MI	196	/* Return a string token representative of the hardware type */
	197	const char pvr2_hdw_get_type(struct pvr2_hdw );
	198
	199	/* Return a single line description of the hardware type */
	200	const char pvr2_hdw_get_desc(struct pvr2_hdw );
	201
d855497e MI	202	/* Turn streaming on/off */
	203	int pvr2_hdw_set_streaming(struct pvr2_hdw *,int);
	204
	205	/* Find out if streaming is on */
	206	int pvr2_hdw_get_streaming(struct pvr2_hdw *);
	207
681c7399 MI	208	/* Retrieve driver overall state */
	209	int pvr2_hdw_get_state(struct pvr2_hdw *);
	210
d855497e MI	211	/* Configure the type of stream to generate */
	212	int pvr2_hdw_set_stream_type(struct pvr2_hdw *, enum pvr2_config);
	213
	214	/* Get handle to video output stream */
	215	struct pvr2_stream pvr2_hdw_get_video_stream(struct pvr2_hdw );
	216
4db666cc MI	217	/* Enable / disable retrieval of CPU firmware or prom contents. This must
	218	be enabled before pvr2_hdw_cpufw_get() will function. Note that doing
	219	this may prevent the device from running (and leaving this mode may
	220	imply a device reset). */
	221	void pvr2_hdw_cpufw_set_enabled(struct pvr2_hdw *,
568efaa2	222	int mode, /* 0=8KB FX2, 1=16KB FX2, 2=PROM */
4db666cc	223	int enable_flag);
d855497e MI	224
	225	/* Return true if we're in a mode for retrieval CPU firmware */
	226	int pvr2_hdw_cpufw_get_enabled(struct pvr2_hdw *);
	227
	228	/* Retrieve a piece of the CPU's firmware at the given offset. Return
	229	value is the number of bytes retrieved or zero if we're past the end or
	230	an error otherwise (e.g. if firmware retrieval is not enabled). */
	231	int pvr2_hdw_cpufw_get(struct pvr2_hdw *,unsigned int offs,
	232	char *buf,unsigned int cnt);
	233
2fdf3d9c	234	/* Retrieve a previously stored v4l minor device number */
8079384e	235	int pvr2_hdw_v4l_get_minor_number(struct pvr2_hdw *,enum pvr2_v4l_type index);
d855497e	236
2fdf3d9c	237	/* Store a v4l minor device number */
fd5a75fe	238	void pvr2_hdw_v4l_store_minor_number(struct pvr2_hdw *,
8079384e	239	enum pvr2_v4l_type index,int);
d855497e	240
d855497e MI	241	/* The following entry points are all lower level things you normally don't
	242	want to worry about. */
	243
d855497e MI	244	/* Issue a command and get a response from the device. LOTS of higher
	245	level stuff is built on this. */
	246	int pvr2_send_request(struct pvr2_hdw *,
	247	void *write_ptr,unsigned int write_len,
	248	void *read_ptr,unsigned int read_len);
	249
d855497e MI	250	/* Slightly higher level device communication functions. */
d855497e MI	251	int pvr2_write_register(struct pvr2_hdw *, u16, u32);
d855497e MI	252
	253	/* Call if for any reason we can't talk to the hardware anymore - this will
	254	cause the driver to stop flailing on the device. */
	255	void pvr2_hdw_render_useless(struct pvr2_hdw *);
d855497e MI	256
	257	/* Set / clear 8051's reset bit */
	258	void pvr2_hdw_cpureset_assert(struct pvr2_hdw *,int);
	259
	260	/* Execute a USB-commanded device reset */
	261	void pvr2_hdw_device_reset(struct pvr2_hdw *);
	262
681c7399 MI	263	/* Reset worker's error trapping circuit breaker */
	264	int pvr2_hdw_untrip(struct pvr2_hdw *);
	265
d855497e MI	266	/* Execute hard reset command (after this point it's likely that the
	267	encoder will have to be reconfigured). This also clears the "useless"
	268	state. */
	269	int pvr2_hdw_cmd_deep_reset(struct pvr2_hdw *);
	270
	271	/* Execute simple reset command */
	272	int pvr2_hdw_cmd_powerup(struct pvr2_hdw *);
	273
e1edb19a MK	274	/* suspend */
	275	int pvr2_hdw_cmd_powerdown(struct pvr2_hdw *);
	276
d855497e MI	277	/* Order decoder to reset */
	278	int pvr2_hdw_cmd_decoder_reset(struct pvr2_hdw *);
	279
d855497e MI	280	/* Direct manipulation of GPIO bits */
	281	int pvr2_hdw_gpio_get_dir(struct pvr2_hdw hdw,u32 );
	282	int pvr2_hdw_gpio_get_out(struct pvr2_hdw hdw,u32 );
	283	int pvr2_hdw_gpio_get_in(struct pvr2_hdw hdw,u32 );
	284	int pvr2_hdw_gpio_chg_dir(struct pvr2_hdw *hdw,u32 msk,u32 val);
	285	int pvr2_hdw_gpio_chg_out(struct pvr2_hdw *hdw,u32 msk,u32 val);
	286
	287	/* This data structure is specifically for the next function... */
	288	struct pvr2_hdw_debug_info {
	289	int big_lock_held;
	290	int ctl_lock_held;
d855497e MI	291	int flag_disconnected;
d855497e MI	292	int flag_init_ok;
681c7399 MI	293	int flag_ok;
	294	int fw1_state;
	295	int flag_decoder_missed;
	296	int flag_tripped;
	297	int state_encoder_ok;
	298	int state_encoder_run;
	299	int state_decoder_run;
6e931375	300	int state_decoder_ready;
681c7399 MI	301	int state_usbstream_run;
	302	int state_decoder_quiescent;
	303	int state_pipeline_config;
	304	int state_pipeline_req;
	305	int state_pipeline_pause;
	306	int state_pipeline_idle;
d855497e MI	307	int cmd_debug_state;
	308	int cmd_debug_write_len;
	309	int cmd_debug_read_len;
	310	int cmd_debug_write_pend;
	311	int cmd_debug_read_pend;
	312	int cmd_debug_timeout;
	313	int cmd_debug_rstatus;
	314	int cmd_debug_wstatus;
	315	unsigned char cmd_code;
	316	};
	317
	318	/* Non-intrusively retrieve internal state info - this is useful for
	319	diagnosing lockups. Note that this operation is completed without any
	320	kind of locking and so it is not atomic and may yield inconsistent
	321	results. This is purely a debugging aid. */
681c7399 MI	322	void pvr2_hdw_get_debug_info_unlocked(const struct pvr2_hdw *hdw,
	323	struct pvr2_hdw_debug_info *);
	324
	325	/* Intrusively retrieve internal state info - this is useful for
	326	diagnosing overall driver state. This operation synchronizes against
	327	the overall driver mutex - so if there are locking problems this will
	328	likely hang! This is purely a debugging aid. */
	329	void pvr2_hdw_get_debug_info_locked(struct pvr2_hdw *hdw,
	330	struct pvr2_hdw_debug_info *);
	331
	332	/* Report out several lines of text that describes driver internal state.
	333	Results are written into the passed-in buffer. */
	334	unsigned int pvr2_hdw_state_report(struct pvr2_hdw *hdw,
	335	char *buf_ptr,unsigned int buf_size);
d855497e MI	336
	337	/* Cause modules to log their state once */
	338	void pvr2_hdw_trigger_module_log(struct pvr2_hdw *hdw);
	339
	340	/* Cause encoder firmware to be uploaded into the device. This is normally
	341	done autonomously, but the interface is exported here because it is also
	342	a debugging aid. */
	343	int pvr2_upload_firmware2(struct pvr2_hdw *hdw);
	344
d855497e	345	#endif /* __PVRUSB2_HDW_H */