drivers/media/video/cx18/cx23418.h

   1 /*
   2  *  cx18 header containing common defines.
   3  *
   4  *  Copyright (C) 2007  Hans Verkuil <hverkuil@xs4all.nl>
   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, or
   9  *  (at your option) any later version.
  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
  19  *  02111-1307  USA
  20  */
  21
  22 #ifndef CX23418_H
  23 #define CX23418_H
  24
  25 #include <media/cx2341x.h>
  26
  27 #define MGR_CMD_MASK                            0x40000000
  28 /* The MSB of the command code indicates that this is the completion of a
  29    command */
  30 #define MGR_CMD_MASK_ACK                        (MGR_CMD_MASK | 0x80000000)
  31
  32 /* Description: This command creates a new instance of a certain task
  33    IN[0]  - Task ID. This is one of the XPU_CMD_MASK_YYY where XPU is
  34             the processor on which the task YYY will be created
  35    OUT[0] - Task handle. This handle is passed along with commands to
  36             dispatch to the right instance of the task
  37    ReturnCode - One of the ERR_SYS_... */
  38 #define CX18_CREATE_TASK                        (MGR_CMD_MASK | 0x0001)
  39
  40 /* Description: This command destroys an instance of a task
  41    IN[0] - Task handle. Hanlde of the task to destroy
  42    ReturnCode - One of the ERR_SYS_... */
  43 #define CX18_DESTROY_TASK                       (MGR_CMD_MASK | 0x0002)
  44
  45 /* All commands for CPU have the following mask set */
  46 #define CPU_CMD_MASK                            0x20000000
  47 #define CPU_CMD_MASK_DEBUG                      (CPU_CMD_MASK | 0x00000000)
  48 #define CPU_CMD_MASK_ACK                        (CPU_CMD_MASK | 0x80000000)
  49 #define CPU_CMD_MASK_CAPTURE                    (CPU_CMD_MASK | 0x00020000)
  50 #define CPU_CMD_MASK_TS                         (CPU_CMD_MASK | 0x00040000)
  51
  52 #define EPU_CMD_MASK                            0x02000000
  53 #define EPU_CMD_MASK_DEBUG                      (EPU_CMD_MASK | 0x000000)
  54 #define EPU_CMD_MASK_DE                         (EPU_CMD_MASK | 0x040000)
  55
  56 #define APU_CMD_MASK                            0x10000000
  57 #define APU_CMD_MASK_ACK                        (APU_CMD_MASK | 0x80000000)
  58
  59 #define CX18_APU_ENCODING_METHOD_MPEG           (0 << 28)
  60 #define CX18_APU_ENCODING_METHOD_AC3            (1 << 28)
  61
  62 /* Description: Command APU to start audio
  63    IN[0] - audio parameters (same as CX18_CPU_SET_AUDIO_PARAMETERS?)
  64    IN[1] - caller buffer address, or 0
  65    ReturnCode - ??? */
  66 #define CX18_APU_START                          (APU_CMD_MASK | 0x01)
  67
  68 /* Description: Command APU to stop audio
  69    IN[0] - encoding method to stop
  70    ReturnCode - ??? */
  71 #define CX18_APU_STOP                           (APU_CMD_MASK | 0x02)
  72
  73 /* Description: Command APU to reset the AI
  74    ReturnCode - ??? */
  75 #define CX18_APU_RESETAI                        (APU_CMD_MASK | 0x05)
  76
  77 /* Description: This command indicates that a Memory Descriptor List has been
  78    filled with the requested channel type
  79    IN[0] - Task handle. Handle of the task
  80    IN[1] - Offset of the MDL_ACK from the beginning of the local DDR.
  81    IN[2] - Number of CNXT_MDL_ACK structures in the array pointed to by IN[1]
  82    ReturnCode - One of the ERR_DE_... */
  83 #define CX18_EPU_DMA_DONE                       (EPU_CMD_MASK_DE | 0x0001)
  84
  85 /* Something interesting happened
  86    IN[0] - A value to log
  87    IN[1] - An offset of a string in the MiniMe memory;
  88            0/zero/NULL means "I have nothing to say" */
  89 #define CX18_EPU_DEBUG                          (EPU_CMD_MASK_DEBUG | 0x0003)
  90
  91 /* Reads memory/registers (32-bit)
  92    IN[0] - Address
  93    OUT[1] - Value */
  94 #define CX18_CPU_DEBUG_PEEK32                   (CPU_CMD_MASK_DEBUG | 0x0003)
  95
  96 /* Description: This command starts streaming with the set channel type
  97    IN[0] - Task handle. Handle of the task to start
  98    ReturnCode - One of the ERR_CAPTURE_... */
  99 #define CX18_CPU_CAPTURE_START                  (CPU_CMD_MASK_CAPTURE | 0x0002)
 100
 101 /* Description: This command stops streaming with the set channel type
 102    IN[0] - Task handle. Handle of the task to stop
 103    IN[1] - 0 = stop at end of GOP, 1 = stop at end of frame (MPEG only)
 104    ReturnCode - One of the ERR_CAPTURE_... */
 105 #define CX18_CPU_CAPTURE_STOP                   (CPU_CMD_MASK_CAPTURE | 0x0003)
 106
 107 /* Description: This command pauses streaming with the set channel type
 108    IN[0] - Task handle. Handle of the task to pause
 109    ReturnCode - One of the ERR_CAPTURE_... */
 110 #define CX18_CPU_CAPTURE_PAUSE                  (CPU_CMD_MASK_CAPTURE | 0x0007)
 111
 112 /* Description: This command resumes streaming with the set channel type
 113    IN[0] - Task handle. Handle of the task to resume
 114    ReturnCode - One of the ERR_CAPTURE_... */
 115 #define CX18_CPU_CAPTURE_RESUME                 (CPU_CMD_MASK_CAPTURE | 0x0008)
 116
 117 #define CAPTURE_CHANNEL_TYPE_NONE               0
 118 #define CAPTURE_CHANNEL_TYPE_MPEG               1
 119 #define CAPTURE_CHANNEL_TYPE_INDEX              2
 120 #define CAPTURE_CHANNEL_TYPE_YUV                3
 121 #define CAPTURE_CHANNEL_TYPE_PCM                4
 122 #define CAPTURE_CHANNEL_TYPE_VBI                5
 123 #define CAPTURE_CHANNEL_TYPE_SLICED_VBI         6
 124 #define CAPTURE_CHANNEL_TYPE_TS                 7
 125 #define CAPTURE_CHANNEL_TYPE_MAX                15
 126
 127 /* Description: This command sets the channel type. This can only be done
 128    when stopped.
 129    IN[0] - Task handle. Handle of the task to start
 130    IN[1] - Channel Type. See Below.
 131    ReturnCode - One of the ERR_CAPTURE_... */
 132 #define CX18_CPU_SET_CHANNEL_TYPE               (CPU_CMD_MASK_CAPTURE + 1)
 133
 134 /* Description: Set stream output type
 135    IN[0] - task handle. Handle of the task to start
 136    IN[1] - type
 137    ReturnCode - One of the ERR_CAPTURE_... */
 138 #define CX18_CPU_SET_STREAM_OUTPUT_TYPE         (CPU_CMD_MASK_CAPTURE | 0x0012)
 139
 140 /* Description: Set video input resolution and frame rate
 141    IN[0] - task handle
 142    IN[1] - reserved
 143    IN[2] - reserved
 144    IN[3] - reserved
 145    IN[4] - reserved
 146    IN[5] - frame rate, 0 - 29.97f/s, 1 - 25f/s
 147    ReturnCode - One of the ERR_CAPTURE_... */
 148 #define CX18_CPU_SET_VIDEO_IN                   (CPU_CMD_MASK_CAPTURE | 0x0004)
 149
 150 /* Description: Set video frame rate
 151    IN[0] - task handle. Handle of the task to start
 152    IN[1] - video bit rate mode
 153    IN[2] - video average rate
 154    IN[3] - video peak rate
 155    IN[4] - system mux rate
 156    ReturnCode - One of the ERR_CAPTURE_... */
 157 #define CX18_CPU_SET_VIDEO_RATE                 (CPU_CMD_MASK_CAPTURE | 0x0005)
 158
 159 /* Description: Set video output resolution
 160    IN[0] - task handle
 161    IN[1] - horizontal size
 162    IN[2] - vertical size
 163    ReturnCode - One of the ERR_CAPTURE_... */
 164 #define CX18_CPU_SET_VIDEO_RESOLUTION           (CPU_CMD_MASK_CAPTURE | 0x0006)
 165
 166 /* Description: This command set filter parameters
 167    IN[0] - Task handle. Handle of the task
 168    IN[1] - type, 0 - temporal, 1 - spatial, 2 - median
 169    IN[2] - mode,  temporal/spatial: 0 - disable, 1 - static, 2 - dynamic
 170                         median: 0 = disable, 1 = horizontal, 2 = vertical,
 171                                 3 = horizontal/vertical, 4 = diagonal
 172    IN[3] - strength, temporal 0 - 31, spatial 0 - 15
 173    ReturnCode - One of the ERR_CAPTURE_... */
 174 #define CX18_CPU_SET_FILTER_PARAM               (CPU_CMD_MASK_CAPTURE | 0x0009)
 175
 176 /* Description: This command set spatial filter type
 177    IN[0] - Task handle.
 178    IN[1] - luma type: 0 = disable, 1 = 1D horizontal only, 2 = 1D vertical only,
 179                       3 = 2D H/V separable, 4 = 2D symmetric non-separable
 180    IN[2] - chroma type: 0 - diable, 1 = 1D horizontal
 181    ReturnCode - One of the ERR_CAPTURE_... */
 182 #define CX18_CPU_SET_SPATIAL_FILTER_TYPE        (CPU_CMD_MASK_CAPTURE | 0x000C)
 183
 184 /* Description: This command set coring levels for median filter
 185    IN[0] - Task handle.
 186    IN[1] - luma_high
 187    IN[2] - luma_low
 188    IN[3] - chroma_high
 189    IN[4] - chroma_low
 190    ReturnCode - One of the ERR_CAPTURE_... */
 191 #define CX18_CPU_SET_MEDIAN_CORING              (CPU_CMD_MASK_CAPTURE | 0x000E)
 192
 193 /* Description: This command set the picture type mask for index file
 194    IN[0] -      0 = disable index file output
 195                         1 = output I picture
 196                         2 = P picture
 197                         4 = B picture
 198                         other = illegal */
 199 #define CX18_CPU_SET_INDEXTABLE                 (CPU_CMD_MASK_CAPTURE | 0x0010)
 200
 201 /* Description: Set audio parameters
 202    IN[0] - task handle. Handle of the task to start
 203    IN[1] - audio parameter
 204    ReturnCode - One of the ERR_CAPTURE_... */
 205 #define CX18_CPU_SET_AUDIO_PARAMETERS           (CPU_CMD_MASK_CAPTURE | 0x0011)
 206
 207 /* Description: Set video mute
 208    IN[0] - task handle. Handle of the task to start
 209    IN[1] - bit31-24: muteYvalue
 210            bit23-16: muteUvalue
 211            bit15-8:  muteVvalue
 212            bit0:     1:mute, 0: unmute
 213    ReturnCode - One of the ERR_CAPTURE_... */
 214 #define CX18_CPU_SET_VIDEO_MUTE                 (CPU_CMD_MASK_CAPTURE | 0x0013)
 215
 216 /* Description: Set audio mute
 217    IN[0] - task handle. Handle of the task to start
 218    IN[1] - mute/unmute
 219    ReturnCode - One of the ERR_CAPTURE_... */
 220 #define CX18_CPU_SET_AUDIO_MUTE                 (CPU_CMD_MASK_CAPTURE | 0x0014)
 221
 222 /* Description: Set stream output type
 223    IN[0] - task handle. Handle of the task to start
 224    IN[1] - subType
 225             SET_INITIAL_SCR                     1
 226             SET_QUALITY_MODE            2
 227             SET_VIM_PROTECT_MODE        3
 228             SET_PTS_CORRECTION          4
 229             SET_USB_FLUSH_MODE          5
 230             SET_MERAQPAR_ENABLE         6
 231             SET_NAV_PACK_INSERTION      7
 232             SET_SCENE_CHANGE_ENABLE     8
 233    IN[2] - parameter 1
 234    IN[3] - parameter 2
 235    ReturnCode - One of the ERR_CAPTURE_... */
 236 #define CX18_CPU_SET_MISC_PARAMETERS            (CPU_CMD_MASK_CAPTURE | 0x0015)
 237
 238 /* Description: Set raw VBI parameters
 239    IN[0] - Task handle
 240    IN[1] - No. of input lines per field:
 241                                 bit[15:0]: field 1,
 242                                 bit[31:16]: field 2
 243    IN[2] - No. of input bytes per line
 244    IN[3] - No. of output frames per transfer
 245    IN[4] - start code
 246    IN[5] - stop code
 247    ReturnCode */
 248 #define CX18_CPU_SET_RAW_VBI_PARAM              (CPU_CMD_MASK_CAPTURE | 0x0016)
 249
 250 /* Description: Set capture line No.
 251    IN[0] - task handle. Handle of the task to start
 252    IN[1] - height1
 253    IN[2] - height2
 254    ReturnCode - One of the ERR_CAPTURE_... */
 255 #define CX18_CPU_SET_CAPTURE_LINE_NO            (CPU_CMD_MASK_CAPTURE | 0x0017)
 256
 257 /* Description: Set copyright
 258    IN[0] - task handle. Handle of the task to start
 259    IN[1] - copyright
 260    ReturnCode - One of the ERR_CAPTURE_... */
 261 #define CX18_CPU_SET_COPYRIGHT                  (CPU_CMD_MASK_CAPTURE | 0x0018)
 262
 263 /* Description: Set audio PID
 264    IN[0] - task handle. Handle of the task to start
 265    IN[1] - PID
 266    ReturnCode - One of the ERR_CAPTURE_... */
 267 #define CX18_CPU_SET_AUDIO_PID                  (CPU_CMD_MASK_CAPTURE | 0x0019)
 268
 269 /* Description: Set video PID
 270    IN[0] - task handle. Handle of the task to start
 271    IN[1] - PID
 272    ReturnCode - One of the ERR_CAPTURE_... */
 273 #define CX18_CPU_SET_VIDEO_PID                  (CPU_CMD_MASK_CAPTURE | 0x001A)
 274
 275 /* Description: Set Vertical Crop Line
 276    IN[0] - task handle. Handle of the task to start
 277    IN[1] - Line
 278    ReturnCode - One of the ERR_CAPTURE_... */
 279 #define CX18_CPU_SET_VER_CROP_LINE              (CPU_CMD_MASK_CAPTURE | 0x001B)
 280
 281 /* Description: Set COP structure
 282    IN[0] - task handle. Handle of the task to start
 283    IN[1] - M
 284    IN[2] - N
 285    ReturnCode - One of the ERR_CAPTURE_... */
 286 #define CX18_CPU_SET_GOP_STRUCTURE              (CPU_CMD_MASK_CAPTURE | 0x001C)
 287
 288 /* Description: Set Scene Change Detection
 289    IN[0] - task handle. Handle of the task to start
 290    IN[1] - scene change
 291    ReturnCode - One of the ERR_CAPTURE_... */
 292 #define CX18_CPU_SET_SCENE_CHANGE_DETECTION     (CPU_CMD_MASK_CAPTURE | 0x001D)
 293
 294 /* Description: Set Aspect Ratio
 295    IN[0] - task handle. Handle of the task to start
 296    IN[1] - AspectRatio
 297    ReturnCode - One of the ERR_CAPTURE_... */
 298 #define CX18_CPU_SET_ASPECT_RATIO               (CPU_CMD_MASK_CAPTURE | 0x001E)
 299
 300 /* Description: Set Skip Input Frame
 301    IN[0] - task handle. Handle of the task to start
 302    IN[1] - skip input frames
 303    ReturnCode - One of the ERR_CAPTURE_... */
 304 #define CX18_CPU_SET_SKIP_INPUT_FRAME           (CPU_CMD_MASK_CAPTURE | 0x001F)
 305
 306 /* Description: Set sliced VBI parameters -
 307    Note This API will only apply to MPEG and Sliced VBI Channels
 308    IN[0] - Task handle
 309    IN[1] - output type, 0 - CC, 1 - Moji, 2 - Teletext
 310    IN[2] - start / stop line
 311                         bit[15:0] start line number
 312                         bit[31:16] stop line number
 313    IN[3] - number of output frames per interrupt
 314    IN[4] - VBI insertion mode
 315                         bit 0:  output user data, 1 - enable
 316                         bit 1:  output private stream, 1 - enable
 317                         bit 2:  mux option, 0 - in GOP, 1 - in picture
 318                         bit[7:0]        private stream ID
 319    IN[5] - insertion period while mux option is in picture
 320    ReturnCode - VBI data offset */
 321 #define CX18_CPU_SET_SLICED_VBI_PARAM           (CPU_CMD_MASK_CAPTURE | 0x0020)
 322
 323 /* Description: Set the user data place holder
 324    IN[0] - type of data (0 for user)
 325    IN[1] - Stuffing period
 326    IN[2] - ID data size in word (less than 10)
 327    IN[3] - Pointer to ID buffer */
 328 #define CX18_CPU_SET_USERDATA_PLACE_HOLDER      (CPU_CMD_MASK_CAPTURE | 0x0021)
 329
 330
 331 /* Description:
 332    In[0] Task Handle
 333    return parameter:
 334    Out[0]  Reserved
 335    Out[1]  Video PTS bit[32:2] of last output video frame.
 336    Out[2]  Video PTS bit[ 1:0] of last output video frame.
 337    Out[3]  Hardware Video PTS counter bit[31:0],
 338              these bits get incremented on every 90kHz clock tick.
 339    Out[4]  Hardware Video PTS counter bit32,
 340              these bits get incremented on every 90kHz clock tick.
 341    ReturnCode */
 342 #define CX18_CPU_GET_ENC_PTS                    (CPU_CMD_MASK_CAPTURE | 0x0022)
 343
 344 /* Below is the list of commands related to the data exchange */
 345 #define CPU_CMD_MASK_DE                         (CPU_CMD_MASK | 0x040000)
 346
 347 /* Description: This command provides the physical base address of the local
 348    DDR as viewed by EPU
 349    IN[0] - Physical offset where EPU has the local DDR mapped
 350    ReturnCode - One of the ERR_DE_... */
 351 #define CPU_CMD_DE_SetBase                      (CPU_CMD_MASK_DE | 0x0001)
 352
 353 /* Description: This command provides the offsets in the device memory where
 354    the 2 cx18_mdl_ack blocks reside
 355    IN[0] - Task handle. Handle of the task to start
 356    IN[1] - Offset of the first cx18_mdl_ack from the beginning of the
 357            local DDR.
 358    IN[2] - Offset of the second cx18_mdl_ack from the beginning of the
 359            local DDR.
 360    ReturnCode - One of the ERR_DE_... */
 361 #define CX18_CPU_DE_SET_MDL_ACK                 (CPU_CMD_MASK_DE | 0x0002)
 362
 363 /* Description: This command provides the offset to a Memory Descriptor List
 364    IN[0] - Task handle. Handle of the task to start
 365    IN[1] - Offset of the MDL from the beginning of the local DDR.
 366    IN[2] - Number of cx18_mdl_ent structures in the array pointed to by IN[1]
 367    IN[3] - Buffer ID
 368    IN[4] - Total buffer length
 369    ReturnCode - One of the ERR_DE_... */
 370 #define CX18_CPU_DE_SET_MDL                     (CPU_CMD_MASK_DE | 0x0005)
 371
 372 /* Description: This command requests return of all current Memory
 373    Descriptor Lists to the driver
 374    IN[0] - Task handle. Handle of the task to start
 375    ReturnCode - One of the ERR_DE_... */
 376 #define CX18_CPU_DE_RELEASE_MDL                 (CPU_CMD_MASK_DE | 0x0006)
 377
 378 /* Description: This command signals the cpu that the dat buffer has been
 379    consumed and ready for re-use.
 380    IN[0] - Task handle. Handle of the task
 381    IN[1] - Offset of the data block from the beginning of the local DDR.
 382    IN[2] - Number of bytes in the data block
 383    ReturnCode - One of the ERR_DE_... */
 384 /* #define CX18_CPU_DE_RELEASE_BUFFER           (CPU_CMD_MASK_DE | 0x0007) */
 385
 386 /* No Error / Success */
 387 #define CNXT_OK                 0x000000
 388
 389 /* Received unknown command */
 390 #define CXERR_UNK_CMD           0x000001
 391
 392 /* First parameter in the command is invalid */
 393 #define CXERR_INVALID_PARAM1    0x000002
 394
 395 /* Second parameter in the command is invalid */
 396 #define CXERR_INVALID_PARAM2    0x000003
 397
 398 /* Device interface is not open/found */
 399 #define CXERR_DEV_NOT_FOUND     0x000004
 400
 401 /* Requested function is not implemented/available */
 402 #define CXERR_NOTSUPPORTED      0x000005
 403
 404 /* Invalid pointer is provided */
 405 #define CXERR_BADPTR            0x000006
 406
 407 /* Unable to allocate memory */
 408 #define CXERR_NOMEM             0x000007
 409
 410 /* Object/Link not found */
 411 #define CXERR_LINK              0x000008
 412
 413 /* Device busy, command cannot be executed */
 414 #define CXERR_BUSY              0x000009
 415
 416 /* File/device/handle is not open. */
 417 #define CXERR_NOT_OPEN          0x00000A
 418
 419 /* Value is out of range */
 420 #define CXERR_OUTOFRANGE        0x00000B
 421
 422 /* Buffer overflow */
 423 #define CXERR_OVERFLOW          0x00000C
 424
 425 /* Version mismatch */
 426 #define CXERR_BADVER            0x00000D
 427
 428 /* Operation timed out */
 429 #define CXERR_TIMEOUT           0x00000E
 430
 431 /* Operation aborted */
 432 #define CXERR_ABORT             0x00000F
 433
 434 /* Specified I2C device not found for read/write */
 435 #define CXERR_I2CDEV_NOTFOUND   0x000010
 436
 437 /* Error in I2C data xfer (but I2C device is present) */
 438 #define CXERR_I2CDEV_XFERERR    0x000011
 439
 440 /* Chanel changing component not ready */
 441 #define CXERR_CHANNELNOTREADY   0x000012
 442
 443 /* PPU (Presensation/Decoder) mail box is corrupted */
 444 #define CXERR_PPU_MB_CORRUPT    0x000013
 445
 446 /* CPU (Capture/Encoder) mail box is corrupted */
 447 #define CXERR_CPU_MB_CORRUPT    0x000014
 448
 449 /* APU (Audio) mail box is corrupted */
 450 #define CXERR_APU_MB_CORRUPT    0x000015
 451
 452 /* Unable to open file for reading */
 453 #define CXERR_FILE_OPEN_READ    0x000016
 454
 455 /* Unable to open file for writing */
 456 #define CXERR_FILE_OPEN_WRITE   0x000017
 457
 458 /* Unable to find the I2C section specified */
 459 #define CXERR_I2C_BADSECTION    0x000018
 460
 461 /* Error in I2C data xfer (but I2C device is present) */
 462 #define CXERR_I2CDEV_DATALOW    0x000019
 463
 464 /* Error in I2C data xfer (but I2C device is present) */
 465 #define CXERR_I2CDEV_CLOCKLOW   0x00001A
 466
 467 /* No Interrupt received from HW (for I2C access) */
 468 #define CXERR_NO_HW_I2C_INTR    0x00001B
 469
 470 /* RPU is not ready to accept commands! */
 471 #define CXERR_RPU_NOT_READY     0x00001C
 472
 473 /* RPU is not ready to accept commands! */
 474 #define CXERR_RPU_NO_ACK        0x00001D
 475
 476 /* The are no buffers ready. Try again soon! */
 477 #define CXERR_NODATA_AGAIN      0x00001E
 478
 479 /* The stream is stopping. Function not alllowed now! */
 480 #define CXERR_STOPPING_STATUS   0x00001F
 481
 482 /* Trying to access hardware when the power is turned OFF */
 483 #define CXERR_DEVPOWER_OFF      0x000020
 484
 485 #endif /* CX23418_H */