drivers/media/video/cx25840/cx25840-firmware.c

   1 /* cx25840 firmware functions
   2  *
   3  * This program is free software; you can redistribute it and/or
   4  * modify it under the terms of the GNU General Public License
   5  * as published by the Free Software Foundation; either version 2
   6  * of the License, or (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  16  */
  17
  18 #include <linux/module.h>
  19 #include <linux/i2c.h>
  20 #include <linux/i2c-algo-bit.h>
  21 #include <linux/firmware.h>
  22 #include <media/v4l2-common.h>
  23 #include <media/cx25840.h>
  24
  25 #include "cx25840-core.h"
  26
  27 #define FWFILE "v4l-cx25840.fw"
  28
  29 /*
  30  * Mike Isely <isely@pobox.com> - The FWSEND parameter controls the
  31  * size of the firmware chunks sent down the I2C bus to the chip.
  32  * Previously this had been set to 1024 but unfortunately some I2C
  33  * implementations can't transfer data in such big gulps.
  34  * Specifically, the pvrusb2 driver has a hard limit of around 60
  35  * bytes, due to the encapsulation there of I2C traffic into USB
  36  * messages.  So we have to significantly reduce this parameter.
  37  */
  38 #define FWSEND 48
  39
  40 #define FWDEV(x) &((x)->adapter->dev)
  41
  42 static int fastfw = 1;
  43 static char *firmware = FWFILE;
  44
  45 module_param(fastfw, bool, 0444);
  46 module_param(firmware, charp, 0444);
  47
  48 MODULE_PARM_DESC(fastfw, "Load firmware fast [0=100MHz 1=333MHz (default)]");
  49 MODULE_PARM_DESC(firmware, "Firmware image [default: " FWFILE "]");
  50
  51 static void set_i2c_delay(struct i2c_client *client, int delay)
  52 {
  53         struct i2c_algo_bit_data *algod = client->adapter->algo_data;
  54
  55         /* We aren't guaranteed to be using algo_bit,
  56          * so avoid the null pointer dereference
  57          * and disable the 'fast firmware load' */
  58         if (algod) {
  59                 algod->udelay = delay;
  60         } else {
  61                 fastfw = 0;
  62         }
  63 }
  64
  65 static void start_fw_load(struct i2c_client *client)
  66 {
  67         /* DL_ADDR_LB=0 DL_ADDR_HB=0 */
  68         cx25840_write(client, 0x800, 0x00);
  69         cx25840_write(client, 0x801, 0x00);
  70         // DL_MAP=3 DL_AUTO_INC=0 DL_ENABLE=1
  71         cx25840_write(client, 0x803, 0x0b);
  72         /* AUTO_INC_DIS=1 */
  73         cx25840_write(client, 0x000, 0x20);
  74
  75         if (fastfw)
  76                 set_i2c_delay(client, 3);
  77 }
  78
  79 static void end_fw_load(struct i2c_client *client)
  80 {
  81         if (fastfw)
  82                 set_i2c_delay(client, 10);
  83
  84         /* AUTO_INC_DIS=0 */
  85         cx25840_write(client, 0x000, 0x00);
  86         /* DL_ENABLE=0 */
  87         cx25840_write(client, 0x803, 0x03);
  88 }
  89
  90 static int check_fw_load(struct i2c_client *client, int size)
  91 {
  92         /* DL_ADDR_HB DL_ADDR_LB */
  93         int s = cx25840_read(client, 0x801) << 8;
  94         s |= cx25840_read(client, 0x800);
  95
  96         if (size != s) {
  97                 v4l_err(client, "firmware %s load failed\n", firmware);
  98                 return -EINVAL;
  99         }
 100
 101         v4l_info(client, "loaded %s firmware (%d bytes)\n", firmware, size);
 102         return 0;
 103 }
 104
 105 static int fw_write(struct i2c_client *client, u8 * data, int size)
 106 {
 107         int sent;
 108
 109         if ((sent = i2c_master_send(client, data, size)) < size) {
 110
 111                 if (fastfw) {
 112                         v4l_err(client, "333MHz i2c firmware load failed\n");
 113                         fastfw = 0;
 114                         set_i2c_delay(client, 10);
 115
 116                         if (sent > 2) {
 117                                 u16 dl_addr = cx25840_read(client, 0x801) << 8;
 118                                 dl_addr |= cx25840_read(client, 0x800);
 119                                 dl_addr -= sent - 2;
 120                                 cx25840_write(client, 0x801, dl_addr >> 8);
 121                                 cx25840_write(client, 0x800, dl_addr & 0xff);
 122                         }
 123
 124                         if (i2c_master_send(client, data, size) < size) {
 125                                 v4l_err(client, "100MHz i2c firmware load failed\n");
 126                                 return -ENOSYS;
 127                         }
 128
 129                 } else {
 130                         v4l_err(client, "firmware load i2c failure\n");
 131                         return -ENOSYS;
 132                 }
 133
 134         }
 135
 136         return 0;
 137 }
 138
 139 int cx25840_loadfw(struct i2c_client *client)
 140 {
 141         const struct firmware *fw = NULL;
 142         u8 buffer[4], *ptr;
 143         int size, send, retval;
 144
 145         if (request_firmware(&fw, firmware, FWDEV(client)) != 0) {
 146                 v4l_err(client, "unable to open firmware %s\n", firmware);
 147                 return -EINVAL;
 148         }
 149
 150         start_fw_load(client);
 151
 152         buffer[0] = 0x08;
 153         buffer[1] = 0x02;
 154         buffer[2] = fw->data[0];
 155         buffer[3] = fw->data[1];
 156         retval = fw_write(client, buffer, 4);
 157
 158         if (retval < 0) {
 159                 release_firmware(fw);
 160                 return retval;
 161         }
 162
 163         size = fw->size - 2;
 164         ptr = fw->data;
 165         while (size > 0) {
 166                 ptr[0] = 0x08;
 167                 ptr[1] = 0x02;
 168                 send = size > (FWSEND - 2) ? FWSEND : size + 2;
 169                 retval = fw_write(client, ptr, send);
 170
 171                 if (retval < 0) {
 172                         release_firmware(fw);
 173                         return retval;
 174                 }
 175
 176                 size -= FWSEND - 2;
 177                 ptr += FWSEND - 2;
 178         }
 179
 180         end_fw_load(client);
 181
 182         size = fw->size;
 183         release_firmware(fw);
 184
 185         return check_fw_load(client, size);
 186 }