drivers/media/video/ivtv/ivtv-mailbox.c

   1 /*
   2     mailbox functions
   3     Copyright (C) 2003-2004  Kevin Thayer <nufan_wfk at yahoo.com>
   4     Copyright (C) 2004  Chris Kennedy <c@groovy.org>
   5     Copyright (C) 2005-2007  Hans Verkuil <hverkuil@xs4all.nl>
   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, or
  10     (at your option) any later version.
  11
  12     This program is distributed in the hope that it will be useful,
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15     GNU General Public License for more details.
  16
  17     You should have received a copy of the GNU General Public License
  18     along with this program; if not, write to the Free Software
  19     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  */
  21
  22 #include <stdarg.h>
  23
  24 #include "ivtv-driver.h"
  25 #include "ivtv-mailbox.h"
  26
  27 /* Firmware mailbox flags*/
  28 #define IVTV_MBOX_FIRMWARE_DONE 0x00000004
  29 #define IVTV_MBOX_DRIVER_DONE   0x00000002
  30 #define IVTV_MBOX_DRIVER_BUSY   0x00000001
  31 #define IVTV_MBOX_FREE          0x00000000
  32
  33 /* Firmware mailbox standard timeout */
  34 #define IVTV_API_STD_TIMEOUT    0x02000000
  35
  36 #define API_CACHE        (1 << 0)       /* Allow the command to be stored in the cache */
  37 #define API_RESULT       (1 << 1)       /* Allow 1 second for this cmd to end */
  38 #define API_FAST_RESULT  (3 << 1)       /* Allow 0.1 second for this cmd to end */
  39 #define API_DMA          (1 << 3)       /* DMA mailbox, has special handling */
  40 #define API_HIGH_VOL     (1 << 5)       /* High volume command (i.e. called during encoding or decoding) */
  41 #define API_NO_WAIT_MB   (1 << 4)       /* Command may not wait for a free mailbox */
  42 #define API_NO_WAIT_RES  (1 << 5)       /* Command may not wait for the result */
  43
  44 struct ivtv_api_info {
  45         int flags;              /* Flags, see above */
  46         const char *name;       /* The name of the command */
  47 };
  48
  49 #define API_ENTRY(x, f) [x] = { (f), #x }
  50
  51 static const struct ivtv_api_info api_info[256] = {
  52         /* MPEG encoder API */
  53         API_ENTRY(CX2341X_ENC_PING_FW,                  API_FAST_RESULT),
  54         API_ENTRY(CX2341X_ENC_START_CAPTURE,            API_RESULT),
  55         API_ENTRY(CX2341X_ENC_STOP_CAPTURE,             API_RESULT),
  56         API_ENTRY(CX2341X_ENC_SET_AUDIO_ID,             API_CACHE),
  57         API_ENTRY(CX2341X_ENC_SET_VIDEO_ID,             API_CACHE),
  58         API_ENTRY(CX2341X_ENC_SET_PCR_ID,               API_CACHE),
  59         API_ENTRY(CX2341X_ENC_SET_FRAME_RATE,           API_CACHE),
  60         API_ENTRY(CX2341X_ENC_SET_FRAME_SIZE,           API_CACHE),
  61         API_ENTRY(CX2341X_ENC_SET_BIT_RATE,             API_CACHE),
  62         API_ENTRY(CX2341X_ENC_SET_GOP_PROPERTIES,       API_CACHE),
  63         API_ENTRY(CX2341X_ENC_SET_ASPECT_RATIO,         API_CACHE),
  64         API_ENTRY(CX2341X_ENC_SET_DNR_FILTER_MODE,      API_CACHE),
  65         API_ENTRY(CX2341X_ENC_SET_DNR_FILTER_PROPS,     API_CACHE),
  66         API_ENTRY(CX2341X_ENC_SET_CORING_LEVELS,        API_CACHE),
  67         API_ENTRY(CX2341X_ENC_SET_SPATIAL_FILTER_TYPE,  API_CACHE),
  68         API_ENTRY(CX2341X_ENC_SET_VBI_LINE,             API_RESULT),
  69         API_ENTRY(CX2341X_ENC_SET_STREAM_TYPE,          API_CACHE),
  70         API_ENTRY(CX2341X_ENC_SET_OUTPUT_PORT,          API_CACHE),
  71         API_ENTRY(CX2341X_ENC_SET_AUDIO_PROPERTIES,     API_CACHE),
  72         API_ENTRY(CX2341X_ENC_HALT_FW,                  API_FAST_RESULT),
  73         API_ENTRY(CX2341X_ENC_GET_VERSION,              API_FAST_RESULT),
  74         API_ENTRY(CX2341X_ENC_SET_GOP_CLOSURE,          API_CACHE),
  75         API_ENTRY(CX2341X_ENC_GET_SEQ_END,              API_RESULT),
  76         API_ENTRY(CX2341X_ENC_SET_PGM_INDEX_INFO,       API_FAST_RESULT),
  77         API_ENTRY(CX2341X_ENC_SET_VBI_CONFIG,           API_RESULT),
  78         API_ENTRY(CX2341X_ENC_SET_DMA_BLOCK_SIZE,       API_CACHE),
  79         API_ENTRY(CX2341X_ENC_GET_PREV_DMA_INFO_MB_10,  API_FAST_RESULT),
  80         API_ENTRY(CX2341X_ENC_GET_PREV_DMA_INFO_MB_9,   API_FAST_RESULT),
  81         API_ENTRY(CX2341X_ENC_SCHED_DMA_TO_HOST,        API_DMA | API_HIGH_VOL),
  82         API_ENTRY(CX2341X_ENC_INITIALIZE_INPUT,         API_RESULT),
  83         API_ENTRY(CX2341X_ENC_SET_FRAME_DROP_RATE,      API_CACHE),
  84         API_ENTRY(CX2341X_ENC_PAUSE_ENCODER,            API_RESULT),
  85         API_ENTRY(CX2341X_ENC_REFRESH_INPUT,            API_NO_WAIT_MB | API_HIGH_VOL),
  86         API_ENTRY(CX2341X_ENC_SET_COPYRIGHT,            API_CACHE),
  87         API_ENTRY(CX2341X_ENC_SET_EVENT_NOTIFICATION,   API_RESULT),
  88         API_ENTRY(CX2341X_ENC_SET_NUM_VSYNC_LINES,      API_CACHE),
  89         API_ENTRY(CX2341X_ENC_SET_PLACEHOLDER,          API_CACHE),
  90         API_ENTRY(CX2341X_ENC_MUTE_VIDEO,               API_RESULT),
  91         API_ENTRY(CX2341X_ENC_MUTE_AUDIO,               API_RESULT),
  92         API_ENTRY(CX2341X_ENC_SET_VERT_CROP_LINE,       API_FAST_RESULT),
  93         API_ENTRY(CX2341X_ENC_MISC,                     API_FAST_RESULT),
  94         /* Obsolete PULLDOWN API command */
  95         API_ENTRY(0xb1,                                 API_CACHE),
  96
  97         /* MPEG decoder API */
  98         API_ENTRY(CX2341X_DEC_PING_FW,                  API_FAST_RESULT),
  99         API_ENTRY(CX2341X_DEC_START_PLAYBACK,           API_RESULT),
 100         API_ENTRY(CX2341X_DEC_STOP_PLAYBACK,            API_RESULT),
 101         API_ENTRY(CX2341X_DEC_SET_PLAYBACK_SPEED,       API_RESULT),
 102         API_ENTRY(CX2341X_DEC_STEP_VIDEO,               API_RESULT),
 103         API_ENTRY(CX2341X_DEC_SET_DMA_BLOCK_SIZE,       API_CACHE),
 104         API_ENTRY(CX2341X_DEC_GET_XFER_INFO,            API_FAST_RESULT),
 105         API_ENTRY(CX2341X_DEC_GET_DMA_STATUS,           API_FAST_RESULT),
 106         API_ENTRY(CX2341X_DEC_SCHED_DMA_FROM_HOST,      API_DMA | API_HIGH_VOL),
 107         API_ENTRY(CX2341X_DEC_PAUSE_PLAYBACK,           API_RESULT),
 108         API_ENTRY(CX2341X_DEC_HALT_FW,                  API_FAST_RESULT),
 109         API_ENTRY(CX2341X_DEC_SET_STANDARD,             API_CACHE),
 110         API_ENTRY(CX2341X_DEC_GET_VERSION,              API_FAST_RESULT),
 111         API_ENTRY(CX2341X_DEC_SET_STREAM_INPUT,         API_CACHE),
 112         API_ENTRY(CX2341X_DEC_GET_TIMING_INFO,          API_RESULT /*| API_NO_WAIT_RES*/),
 113         API_ENTRY(CX2341X_DEC_SET_AUDIO_MODE,           API_CACHE),
 114         API_ENTRY(CX2341X_DEC_SET_EVENT_NOTIFICATION,   API_RESULT),
 115         API_ENTRY(CX2341X_DEC_SET_DISPLAY_BUFFERS,      API_CACHE),
 116         API_ENTRY(CX2341X_DEC_EXTRACT_VBI,              API_RESULT),
 117         API_ENTRY(CX2341X_DEC_SET_DECODER_SOURCE,       API_FAST_RESULT),
 118         API_ENTRY(CX2341X_DEC_SET_PREBUFFERING,         API_CACHE),
 119
 120         /* OSD API */
 121         API_ENTRY(CX2341X_OSD_GET_FRAMEBUFFER,          API_FAST_RESULT),
 122         API_ENTRY(CX2341X_OSD_GET_PIXEL_FORMAT,         API_FAST_RESULT),
 123         API_ENTRY(CX2341X_OSD_SET_PIXEL_FORMAT,         API_CACHE),
 124         API_ENTRY(CX2341X_OSD_GET_STATE,                API_FAST_RESULT),
 125         API_ENTRY(CX2341X_OSD_SET_STATE,                API_CACHE),
 126         API_ENTRY(CX2341X_OSD_GET_OSD_COORDS,           API_FAST_RESULT),
 127         API_ENTRY(CX2341X_OSD_SET_OSD_COORDS,           API_CACHE),
 128         API_ENTRY(CX2341X_OSD_GET_SCREEN_COORDS,        API_FAST_RESULT),
 129         API_ENTRY(CX2341X_OSD_SET_SCREEN_COORDS,        API_CACHE),
 130         API_ENTRY(CX2341X_OSD_GET_GLOBAL_ALPHA,         API_FAST_RESULT),
 131         API_ENTRY(CX2341X_OSD_SET_GLOBAL_ALPHA,         API_CACHE),
 132         API_ENTRY(CX2341X_OSD_SET_BLEND_COORDS,         API_CACHE),
 133         API_ENTRY(CX2341X_OSD_GET_FLICKER_STATE,        API_FAST_RESULT),
 134         API_ENTRY(CX2341X_OSD_SET_FLICKER_STATE,        API_CACHE),
 135         API_ENTRY(CX2341X_OSD_BLT_COPY,                 API_RESULT),
 136         API_ENTRY(CX2341X_OSD_BLT_FILL,                 API_RESULT),
 137         API_ENTRY(CX2341X_OSD_BLT_TEXT,                 API_RESULT),
 138         API_ENTRY(CX2341X_OSD_SET_FRAMEBUFFER_WINDOW,   API_CACHE),
 139         API_ENTRY(CX2341X_OSD_SET_CHROMA_KEY,           API_CACHE),
 140         API_ENTRY(CX2341X_OSD_GET_ALPHA_CONTENT_INDEX,  API_FAST_RESULT),
 141         API_ENTRY(CX2341X_OSD_SET_ALPHA_CONTENT_INDEX,  API_CACHE)
 142 };
 143
 144 static int try_mailbox(struct ivtv *itv, struct ivtv_mailbox_data *mbdata, int mb)
 145 {
 146         u32 flags = readl(&mbdata->mbox[mb].flags);
 147         int is_free = flags == IVTV_MBOX_FREE || (flags & IVTV_MBOX_FIRMWARE_DONE);
 148
 149         /* if the mailbox is free, then try to claim it */
 150         if (is_free && !test_and_set_bit(mb, &mbdata->busy)) {
 151                 write_sync(IVTV_MBOX_DRIVER_BUSY, &mbdata->mbox[mb].flags);
 152                 return 1;
 153         }
 154         return 0;
 155 }
 156
 157 /* Try to find a free mailbox. Note mailbox 0 is reserved for DMA and so is not
 158    attempted here. */
 159 static int get_mailbox(struct ivtv *itv, struct ivtv_mailbox_data *mbdata, int flags)
 160 {
 161         unsigned long then = jiffies;
 162         int i, mb;
 163         int max_mbox = mbdata->max_mbox;
 164         int retries = 100;
 165
 166         /* All slow commands use the same mailbox, serializing them and also
 167            leaving the other mailbox free for simple fast commands. */
 168         if ((flags & API_FAST_RESULT) == API_RESULT)
 169                 max_mbox = 1;
 170
 171         /* find free non-DMA mailbox */
 172         for (i = 0; i < retries; i++) {
 173                 for (mb = 1; mb <= max_mbox; mb++)
 174                         if (try_mailbox(itv, mbdata, mb))
 175                                 return mb;
 176
 177                 /* Sleep before a retry, if not atomic */
 178                 if (!(flags & API_NO_WAIT_MB)) {
 179                         if (jiffies - then > msecs_to_jiffies(10*retries))
 180                                break;
 181                         ivtv_msleep_timeout(10, 0);
 182                 }
 183         }
 184         return -ENODEV;
 185 }
 186
 187 static void write_mailbox(volatile struct ivtv_mailbox __iomem *mbox, int cmd, int args, u32 data[])
 188 {
 189         int i;
 190
 191         write_sync(cmd, &mbox->cmd);
 192         write_sync(IVTV_API_STD_TIMEOUT, &mbox->timeout);
 193
 194         for (i = 0; i < CX2341X_MBOX_MAX_DATA; i++)
 195                 write_sync(data[i], &mbox->data[i]);
 196
 197         write_sync(IVTV_MBOX_DRIVER_DONE | IVTV_MBOX_DRIVER_BUSY, &mbox->flags);
 198 }
 199
 200 static void clear_all_mailboxes(struct ivtv *itv, struct ivtv_mailbox_data *mbdata)
 201 {
 202         int i;
 203
 204         for (i = 0; i <= mbdata->max_mbox; i++) {
 205                 IVTV_DEBUG_WARN("Clearing mailbox %d: cmd 0x%08x flags 0x%08x\n",
 206                         i, readl(&mbdata->mbox[i].cmd), readl(&mbdata->mbox[i].flags));
 207                 write_sync(0, &mbdata->mbox[i].flags);
 208                 clear_bit(i, &mbdata->busy);
 209         }
 210 }
 211
 212 static int ivtv_api_call(struct ivtv *itv, int cmd, int args, u32 data[])
 213 {
 214         struct ivtv_mailbox_data *mbdata = (cmd >= 128) ? &itv->enc_mbox : &itv->dec_mbox;
 215         volatile struct ivtv_mailbox __iomem *mbox;
 216         int api_timeout = msecs_to_jiffies(1000);
 217         int flags, mb, i;
 218         unsigned long then;
 219
 220         /* sanity checks */
 221         if (NULL == mbdata) {
 222                 IVTV_ERR("No mailbox allocated\n");
 223                 return -ENODEV;
 224         }
 225         if (args < 0 || args > CX2341X_MBOX_MAX_DATA ||
 226             cmd < 0 || cmd > 255 || api_info[cmd].name == NULL) {
 227                 IVTV_ERR("Invalid API call: cmd = 0x%02x, args = %d\n", cmd, args);
 228                 return -EINVAL;
 229         }
 230
 231         if (api_info[cmd].flags & API_HIGH_VOL) {
 232             IVTV_DEBUG_HI_API("API Call: %s\n", api_info[cmd].name);
 233         }
 234         else {
 235             IVTV_DEBUG_API("API Call: %s\n", api_info[cmd].name);
 236         }
 237
 238         /* clear possibly uninitialized part of data array */
 239         for (i = args; i < CX2341X_MBOX_MAX_DATA; i++)
 240                 data[i] = 0;
 241
 242         /* If this command was issued within the last 30 minutes and with identical
 243            data, then just return 0 as there is no need to issue this command again.
 244            Just an optimization to prevent unnecessary use of mailboxes. */
 245         if (itv->api_cache[cmd].last_jiffies &&
 246             jiffies - itv->api_cache[cmd].last_jiffies < msecs_to_jiffies(1800000) &&
 247             !memcmp(data, itv->api_cache[cmd].data, sizeof(itv->api_cache[cmd].data))) {
 248                 itv->api_cache[cmd].last_jiffies = jiffies;
 249                 return 0;
 250         }
 251
 252         flags = api_info[cmd].flags;
 253
 254         if (flags & API_DMA) {
 255                 for (i = 0; i < 100; i++) {
 256                         mb = i % (mbdata->max_mbox + 1);
 257                         if (try_mailbox(itv, mbdata, mb)) {
 258                                 write_mailbox(&mbdata->mbox[mb], cmd, args, data);
 259                                 clear_bit(mb, &mbdata->busy);
 260                                 return 0;
 261                         }
 262                         IVTV_DEBUG_WARN("%s: mailbox %d not free %08x\n",
 263                                         api_info[cmd].name, mb, readl(&mbdata->mbox[mb].flags));
 264                 }
 265                 IVTV_WARN("Could not find free DMA mailbox for %s\n", api_info[cmd].name);
 266                 clear_all_mailboxes(itv, mbdata);
 267                 return -EBUSY;
 268         }
 269
 270         if ((flags & API_FAST_RESULT) == API_FAST_RESULT)
 271                 api_timeout = msecs_to_jiffies(100);
 272
 273         mb = get_mailbox(itv, mbdata, flags);
 274         if (mb < 0) {
 275                 IVTV_DEBUG_WARN("No free mailbox found (%s)\n", api_info[cmd].name);
 276                 clear_all_mailboxes(itv, mbdata);
 277                 return -EBUSY;
 278         }
 279         mbox = &mbdata->mbox[mb];
 280         write_mailbox(mbox, cmd, args, data);
 281         if (flags & API_CACHE) {
 282                 memcpy(itv->api_cache[cmd].data, data, sizeof(itv->api_cache[cmd].data));
 283                 itv->api_cache[cmd].last_jiffies = jiffies;
 284         }
 285         if ((flags & API_RESULT) == 0) {
 286                 clear_bit(mb, &mbdata->busy);
 287                 return 0;
 288         }
 289
 290         /* Get results */
 291         then = jiffies;
 292
 293         while (!(readl(&mbox->flags) & IVTV_MBOX_FIRMWARE_DONE)) {
 294                 if (jiffies - then > api_timeout) {
 295                         IVTV_DEBUG_WARN("Could not get result (%s)\n", api_info[cmd].name);
 296                         /* reset the mailbox, but it is likely too late already */
 297                         write_sync(0, &mbox->flags);
 298                         clear_bit(mb, &mbdata->busy);
 299                         return -EIO;
 300                 }
 301                 if (flags & API_NO_WAIT_RES)
 302                         mdelay(1);
 303                 else
 304                         ivtv_msleep_timeout(10, 0);
 305         }
 306         if (jiffies - then > msecs_to_jiffies(100))
 307                 IVTV_DEBUG_WARN("%s took %u jiffies\n",
 308                                 api_info[cmd].name,
 309                                 jiffies_to_msecs(jiffies - then));
 310
 311         for (i = 0; i < CX2341X_MBOX_MAX_DATA; i++)
 312                 data[i] = readl(&mbox->data[i]);
 313         write_sync(0, &mbox->flags);
 314         clear_bit(mb, &mbdata->busy);
 315         return 0;
 316 }
 317
 318 int ivtv_api(struct ivtv *itv, int cmd, int args, u32 data[])
 319 {
 320         int res = ivtv_api_call(itv, cmd, args, data);
 321
 322         /* Allow a single retry, probably already too late though.
 323            If there is no free mailbox then that is usually an indication
 324            of a more serious problem. */
 325         return (res == -EBUSY) ? ivtv_api_call(itv, cmd, args, data) : res;
 326 }
 327
 328 int ivtv_api_func(void *priv, int cmd, int in, int out, u32 data[CX2341X_MBOX_MAX_DATA])
 329 {
 330         return ivtv_api(priv, cmd, in, data);
 331 }
 332
 333 int ivtv_vapi_result(struct ivtv *itv, u32 data[CX2341X_MBOX_MAX_DATA], int cmd, int args, ...)
 334 {
 335         va_list ap;
 336         int i;
 337
 338         va_start(ap, args);
 339         for (i = 0; i < args; i++) {
 340                 data[i] = va_arg(ap, u32);
 341         }
 342         va_end(ap);
 343         return ivtv_api(itv, cmd, args, data);
 344 }
 345
 346 int ivtv_vapi(struct ivtv *itv, int cmd, int args, ...)
 347 {
 348         u32 data[CX2341X_MBOX_MAX_DATA];
 349         va_list ap;
 350         int i;
 351
 352         va_start(ap, args);
 353         for (i = 0; i < args; i++) {
 354                 data[i] = va_arg(ap, u32);
 355         }
 356         va_end(ap);
 357         return ivtv_api(itv, cmd, args, data);
 358 }
 359
 360 /* This one is for stuff that can't sleep.. irq handlers, etc.. */
 361 void ivtv_api_get_data(struct ivtv_mailbox_data *mbdata, int mb, u32 data[])
 362 {
 363         int i;
 364
 365         for (i = 0; i < CX2341X_MBOX_MAX_DATA; i++)
 366                 data[i] = readl(&mbdata->mbox[mb].data[i]);
 367 }