xref: /OK3568_Linux_fs/kernel/drivers/media/usb/pvrusb2/pvrusb2-io.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  *  Copyright (C) 2005 Mike Isely <isely@pobox.com>
5*4882a593Smuzhiyun  */
6*4882a593Smuzhiyun #ifndef __PVRUSB2_IO_H
7*4882a593Smuzhiyun #define __PVRUSB2_IO_H
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #include <linux/usb.h>
10*4882a593Smuzhiyun #include <linux/list.h>
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun typedef void (*pvr2_stream_callback)(void *);
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun enum pvr2_buffer_state {
15*4882a593Smuzhiyun 	pvr2_buffer_state_none = 0,   // Not on any list
16*4882a593Smuzhiyun 	pvr2_buffer_state_idle = 1,   // Buffer is ready to be used again
17*4882a593Smuzhiyun 	pvr2_buffer_state_queued = 2, // Buffer has been queued for filling
18*4882a593Smuzhiyun 	pvr2_buffer_state_ready = 3,  // Buffer has data available
19*4882a593Smuzhiyun };
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun struct pvr2_stream;
22*4882a593Smuzhiyun struct pvr2_buffer;
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun struct pvr2_stream_stats {
25*4882a593Smuzhiyun 	unsigned int buffers_in_queue;
26*4882a593Smuzhiyun 	unsigned int buffers_in_idle;
27*4882a593Smuzhiyun 	unsigned int buffers_in_ready;
28*4882a593Smuzhiyun 	unsigned int buffers_processed;
29*4882a593Smuzhiyun 	unsigned int buffers_failed;
30*4882a593Smuzhiyun 	unsigned int bytes_processed;
31*4882a593Smuzhiyun };
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun /* Initialize / tear down stream structure */
34*4882a593Smuzhiyun struct pvr2_stream *pvr2_stream_create(void);
35*4882a593Smuzhiyun void pvr2_stream_destroy(struct pvr2_stream *);
36*4882a593Smuzhiyun void pvr2_stream_setup(struct pvr2_stream *,
37*4882a593Smuzhiyun 		       struct usb_device *dev,int endpoint,
38*4882a593Smuzhiyun 		       unsigned int tolerance);
39*4882a593Smuzhiyun void pvr2_stream_set_callback(struct pvr2_stream *,
40*4882a593Smuzhiyun 			      pvr2_stream_callback func,
41*4882a593Smuzhiyun 			      void *data);
42*4882a593Smuzhiyun void pvr2_stream_get_stats(struct pvr2_stream *,
43*4882a593Smuzhiyun 			   struct pvr2_stream_stats *,
44*4882a593Smuzhiyun 			   int zero_counts);
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun /* Query / set the nominal buffer count */
47*4882a593Smuzhiyun int pvr2_stream_get_buffer_count(struct pvr2_stream *);
48*4882a593Smuzhiyun int pvr2_stream_set_buffer_count(struct pvr2_stream *,unsigned int);
49*4882a593Smuzhiyun 
50*4882a593Smuzhiyun /* Get a pointer to a buffer that is either idle, ready, or is specified
51*4882a593Smuzhiyun    named. */
52*4882a593Smuzhiyun struct pvr2_buffer *pvr2_stream_get_idle_buffer(struct pvr2_stream *);
53*4882a593Smuzhiyun struct pvr2_buffer *pvr2_stream_get_ready_buffer(struct pvr2_stream *);
54*4882a593Smuzhiyun struct pvr2_buffer *pvr2_stream_get_buffer(struct pvr2_stream *sp,int id);
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun /* Find out how many buffers are idle or ready */
57*4882a593Smuzhiyun int pvr2_stream_get_ready_count(struct pvr2_stream *);
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun /* Kill all pending buffers and throw away any ready buffers as well */
61*4882a593Smuzhiyun void pvr2_stream_kill(struct pvr2_stream *);
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun /* Set up the actual storage for a buffer */
64*4882a593Smuzhiyun int pvr2_buffer_set_buffer(struct pvr2_buffer *,void *ptr,unsigned int cnt);
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun /* Find out size of data in the given ready buffer */
67*4882a593Smuzhiyun unsigned int pvr2_buffer_get_count(struct pvr2_buffer *);
68*4882a593Smuzhiyun 
69*4882a593Smuzhiyun /* Retrieve completion code for given ready buffer */
70*4882a593Smuzhiyun int pvr2_buffer_get_status(struct pvr2_buffer *);
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun /* Retrieve ID of given buffer */
73*4882a593Smuzhiyun int pvr2_buffer_get_id(struct pvr2_buffer *);
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun /* Start reading into given buffer (kill it if needed) */
76*4882a593Smuzhiyun int pvr2_buffer_queue(struct pvr2_buffer *);
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun #endif /* __PVRUSB2_IO_H */
79