| Mike Isely | d855497 | 2006-06-26 20:58:46 -0300 | [diff] [blame] | 1 | /* |
| 2 | * |
| 3 | * $Id$ |
| 4 | * |
| 5 | * Copyright (C) 2005 Mike Isely <isely@pobox.com> |
| 6 | * |
| 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 |
| 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 19 | * |
| 20 | */ |
| 21 | #ifndef __PVRUSB2_IO_H |
| 22 | #define __PVRUSB2_IO_H |
| 23 | |
| 24 | #include <linux/usb.h> |
| 25 | #include <linux/list.h> |
| 26 | |
| 27 | typedef void (*pvr2_stream_callback)(void *); |
| 28 | |
| 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 |
| 34 | }; |
| 35 | |
| 36 | struct pvr2_stream; |
| 37 | struct pvr2_buffer; |
| 38 | |
| Mike Isely | ad0992e | 2008-03-28 05:34:45 -0300 | [diff] [blame^] | 39 | struct pvr2_stream_stats { |
| 40 | unsigned int buffers_in_queue; |
| 41 | unsigned int buffers_in_idle; |
| 42 | unsigned int buffers_in_ready; |
| 43 | unsigned int buffers_processed; |
| 44 | unsigned int buffers_failed; |
| 45 | unsigned int bytes_processed; |
| 46 | }; |
| 47 | |
| Mike Isely | d855497 | 2006-06-26 20:58:46 -0300 | [diff] [blame] | 48 | /* Initialize / tear down stream structure */ |
| 49 | struct pvr2_stream *pvr2_stream_create(void); |
| 50 | void pvr2_stream_destroy(struct pvr2_stream *); |
| 51 | void pvr2_stream_setup(struct pvr2_stream *, |
| 52 | struct usb_device *dev,int endpoint, |
| 53 | unsigned int tolerance); |
| 54 | void pvr2_stream_set_callback(struct pvr2_stream *, |
| 55 | pvr2_stream_callback func, |
| 56 | void *data); |
| Mike Isely | ad0992e | 2008-03-28 05:34:45 -0300 | [diff] [blame^] | 57 | void pvr2_stream_get_stats(struct pvr2_stream *, |
| 58 | struct pvr2_stream_stats *, |
| 59 | int zero_counts); |
| Mike Isely | d855497 | 2006-06-26 20:58:46 -0300 | [diff] [blame] | 60 | |
| 61 | /* Query / set the nominal buffer count */ |
| Mike Isely | e61b6fc | 2006-07-18 22:42:18 -0300 | [diff] [blame] | 62 | int pvr2_stream_get_buffer_count(struct pvr2_stream *); |
| Mike Isely | d855497 | 2006-06-26 20:58:46 -0300 | [diff] [blame] | 63 | int pvr2_stream_set_buffer_count(struct pvr2_stream *,unsigned int); |
| 64 | |
| 65 | /* Get a pointer to a buffer that is either idle, ready, or is specified |
| 66 | named. */ |
| 67 | struct pvr2_buffer *pvr2_stream_get_idle_buffer(struct pvr2_stream *); |
| 68 | struct pvr2_buffer *pvr2_stream_get_ready_buffer(struct pvr2_stream *); |
| 69 | struct pvr2_buffer *pvr2_stream_get_buffer(struct pvr2_stream *sp,int id); |
| 70 | |
| 71 | /* Find out how many buffers are idle or ready */ |
| Mike Isely | d855497 | 2006-06-26 20:58:46 -0300 | [diff] [blame] | 72 | int pvr2_stream_get_ready_count(struct pvr2_stream *); |
| 73 | |
| Mike Isely | e61b6fc | 2006-07-18 22:42:18 -0300 | [diff] [blame] | 74 | |
| Mike Isely | d855497 | 2006-06-26 20:58:46 -0300 | [diff] [blame] | 75 | /* Kill all pending buffers and throw away any ready buffers as well */ |
| 76 | void pvr2_stream_kill(struct pvr2_stream *); |
| 77 | |
| 78 | /* Set up the actual storage for a buffer */ |
| 79 | int pvr2_buffer_set_buffer(struct pvr2_buffer *,void *ptr,unsigned int cnt); |
| 80 | |
| 81 | /* Find out size of data in the given ready buffer */ |
| 82 | unsigned int pvr2_buffer_get_count(struct pvr2_buffer *); |
| 83 | |
| 84 | /* Retrieve completion code for given ready buffer */ |
| 85 | int pvr2_buffer_get_status(struct pvr2_buffer *); |
| 86 | |
| Mike Isely | d855497 | 2006-06-26 20:58:46 -0300 | [diff] [blame] | 87 | /* Retrieve ID of given buffer */ |
| 88 | int pvr2_buffer_get_id(struct pvr2_buffer *); |
| 89 | |
| 90 | /* Start reading into given buffer (kill it if needed) */ |
| 91 | int pvr2_buffer_queue(struct pvr2_buffer *); |
| 92 | |
| Mike Isely | d855497 | 2006-06-26 20:58:46 -0300 | [diff] [blame] | 93 | #endif /* __PVRUSB2_IO_H */ |
| 94 | |
| 95 | /* |
| 96 | Stuff for Emacs to see, in order to encourage consistent editing style: |
| 97 | *** Local Variables: *** |
| 98 | *** mode: c *** |
| 99 | *** fill-column: 75 *** |
| 100 | *** tab-width: 8 *** |
| 101 | *** c-basic-offset: 8 *** |
| 102 | *** End: *** |
| 103 | */ |