5 * Copyright (C) 2005 Mike Isely <isely@pobox.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License
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.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #ifndef __PVRUSB2_IO_H
22 #define __PVRUSB2_IO_H
24 #include <linux/usb.h>
25 #include <linux/list.h>
27 typedef void (*pvr2_stream_callback)(void *);
29 enum pvr2_buffer_state {
30 pvr2_buffer_state_none = 0, // Not on any list
31 pvr2_buffer_state_idle = 1, // Buffer is ready to be used again
32 pvr2_buffer_state_queued = 2, // Buffer has been queued for filling
33 pvr2_buffer_state_ready = 3, // Buffer has data available
39 const char *pvr2_buffer_state_decode(enum pvr2_buffer_state);
41 /* Initialize / tear down stream structure */
42 struct pvr2_stream *pvr2_stream_create(void);
43 void pvr2_stream_destroy(struct pvr2_stream *);
44 void pvr2_stream_setup(struct pvr2_stream *,
45 struct usb_device *dev,int endpoint,
46 unsigned int tolerance);
47 void pvr2_stream_set_callback(struct pvr2_stream *,
48 pvr2_stream_callback func,
51 /* Query / set the nominal buffer count */
52 int pvr2_stream_get_buffer_count(struct pvr2_stream *);
53 int pvr2_stream_set_buffer_count(struct pvr2_stream *,unsigned int);
55 /* Get a pointer to a buffer that is either idle, ready, or is specified
57 struct pvr2_buffer *pvr2_stream_get_idle_buffer(struct pvr2_stream *);
58 struct pvr2_buffer *pvr2_stream_get_ready_buffer(struct pvr2_stream *);
59 struct pvr2_buffer *pvr2_stream_get_buffer(struct pvr2_stream *sp,int id);
61 /* Find out how many buffers are idle or ready */
62 int pvr2_stream_get_idle_count(struct pvr2_stream *);
63 int pvr2_stream_get_ready_count(struct pvr2_stream *);
65 /* Kill all pending operations */
66 void pvr2_stream_flush(struct pvr2_stream *);
68 /* Kill all pending buffers and throw away any ready buffers as well */
69 void pvr2_stream_kill(struct pvr2_stream *);
71 /* Set up the actual storage for a buffer */
72 int pvr2_buffer_set_buffer(struct pvr2_buffer *,void *ptr,unsigned int cnt);
74 /* Find out size of data in the given ready buffer */
75 unsigned int pvr2_buffer_get_count(struct pvr2_buffer *);
77 /* Retrieve completion code for given ready buffer */
78 int pvr2_buffer_get_status(struct pvr2_buffer *);
80 /* Retrieve state of given buffer */
81 enum pvr2_buffer_state pvr2_buffer_get_state(struct pvr2_buffer *);
83 /* Retrieve ID of given buffer */
84 int pvr2_buffer_get_id(struct pvr2_buffer *);
86 /* Start reading into given buffer (kill it if needed) */
87 int pvr2_buffer_queue(struct pvr2_buffer *);
89 /* Move buffer back to idle pool (kill it if needed) */
90 int pvr2_buffer_idle(struct pvr2_buffer *);
92 #endif /* __PVRUSB2_IO_H */
95 Stuff for Emacs to see, in order to encourage consistent editing style:
96 *** Local Variables: ***
98 *** fill-column: 75 ***
100 *** c-basic-offset: 8 ***