diff options
Diffstat (limited to 'drivers/media/video/videocodec.h')
-rw-r--r-- | drivers/media/video/videocodec.h | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/drivers/media/video/videocodec.h b/drivers/media/video/videocodec.h index b1239ac7f371..8c233720b6a5 100644 --- a/drivers/media/video/videocodec.h +++ b/drivers/media/video/videocodec.h | |||
@@ -57,7 +57,7 @@ | |||
57 | therfor they may not be initialized. | 57 | therfor they may not be initialized. |
58 | 58 | ||
59 | The other fuctions are just for convenience, as they are for sure used by | 59 | The other fuctions are just for convenience, as they are for sure used by |
60 | most/all of the codecs. The last ones may be ommited, too. | 60 | most/all of the codecs. The last ones may be ommited, too. |
61 | 61 | ||
62 | See the structure declaration below for more information and which data has | 62 | See the structure declaration below for more information and which data has |
63 | to be set up for the master and the slave. | 63 | to be set up for the master and the slave. |
@@ -75,52 +75,52 @@ | |||
75 | /* ========================================== */ | 75 | /* ========================================== */ |
76 | 76 | ||
77 | /* | 77 | /* |
78 | ==== master setup ==== | 78 | ==== master setup ==== |
79 | name -> name of the device structure for reference and debugging | 79 | name -> name of the device structure for reference and debugging |
80 | master_data -> data ref. for the master (e.g. the zr36055,57,67) | 80 | master_data -> data ref. for the master (e.g. the zr36055,57,67) |
81 | readreg -> ref. to read-fn from register (setup by master, used by slave) | 81 | readreg -> ref. to read-fn from register (setup by master, used by slave) |
82 | writereg -> ref. to write-fn to register (setup by master, used by slave) | 82 | writereg -> ref. to write-fn to register (setup by master, used by slave) |
83 | this two functions do the lowlevel I/O job | 83 | this two functions do the lowlevel I/O job |
84 | 84 | ||
85 | ==== slave functionality setup ==== | 85 | ==== slave functionality setup ==== |
86 | slave_data -> data ref. for the slave (e.g. the zr36050,60) | 86 | slave_data -> data ref. for the slave (e.g. the zr36050,60) |
87 | check -> fn-ref. checks availability of an device, returns -EIO on failure or | 87 | check -> fn-ref. checks availability of an device, returns -EIO on failure or |
88 | the type on success | 88 | the type on success |
89 | this makes espcecially sense if a driver module supports more than | 89 | this makes espcecially sense if a driver module supports more than |
90 | one codec which may be quite similar to access, nevertheless it | 90 | one codec which may be quite similar to access, nevertheless it |
91 | is good for a first functionality check | 91 | is good for a first functionality check |
92 | 92 | ||
93 | -- main functions you always need for compression/decompression -- | 93 | -- main functions you always need for compression/decompression -- |
94 | 94 | ||
95 | set_mode -> this fn-ref. resets the entire codec, and sets up the mode | 95 | set_mode -> this fn-ref. resets the entire codec, and sets up the mode |
96 | with the last defined norm/size (or device default if not | 96 | with the last defined norm/size (or device default if not |
97 | available) - it returns 0 if the mode is possible | 97 | available) - it returns 0 if the mode is possible |
98 | set_size -> this fn-ref. sets the norm and image size for | 98 | set_size -> this fn-ref. sets the norm and image size for |
99 | compression/decompression (returns 0 on success) | 99 | compression/decompression (returns 0 on success) |
100 | the norm param is defined in videodev.h (VIDEO_MODE_*) | 100 | the norm param is defined in videodev.h (VIDEO_MODE_*) |
101 | 101 | ||
102 | additional setup may be available, too - but the codec should work with | 102 | additional setup may be available, too - but the codec should work with |
103 | some default values even without this | 103 | some default values even without this |
104 | 104 | ||
105 | set_data -> sets device-specific data (tables, quality etc.) | 105 | set_data -> sets device-specific data (tables, quality etc.) |
106 | get_data -> query device-specific data (tables, quality etc.) | 106 | get_data -> query device-specific data (tables, quality etc.) |
107 | 107 | ||
108 | if the device delivers interrupts, they may be setup/handled here | 108 | if the device delivers interrupts, they may be setup/handled here |
109 | setup_interrupt -> codec irq setup (not needed for 36050/60) | 109 | setup_interrupt -> codec irq setup (not needed for 36050/60) |
110 | handle_interrupt -> codec irq handling (not needed for 36050/60) | 110 | handle_interrupt -> codec irq handling (not needed for 36050/60) |
111 | 111 | ||
112 | if the device delivers pictures, they may be handled here | 112 | if the device delivers pictures, they may be handled here |
113 | put_image -> puts image data to the codec (not needed for 36050/60) | 113 | put_image -> puts image data to the codec (not needed for 36050/60) |
114 | get_image -> gets image data from the codec (not needed for 36050/60) | 114 | get_image -> gets image data from the codec (not needed for 36050/60) |
115 | the calls include frame numbers and flags (even/odd/...) | 115 | the calls include frame numbers and flags (even/odd/...) |
116 | if needed and a flag which allows blocking until its ready | 116 | if needed and a flag which allows blocking until its ready |
117 | */ | 117 | */ |
118 | 118 | ||
119 | /* ============== */ | 119 | /* ============== */ |
120 | /* user interface */ | 120 | /* user interface */ |
121 | /* ============== */ | 121 | /* ============== */ |
122 | 122 | ||
123 | /* | 123 | /* |
124 | Currently there is only a information display planned, as the layer | 124 | Currently there is only a information display planned, as the layer |
125 | is not visible for the user space at all. | 125 | is not visible for the user space at all. |
126 | 126 | ||