Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 1 | /* |
| 2 | * intel_scu_ipc.c: Driver for the Intel SCU IPC mechanism |
| 3 | * |
| 4 | * (C) Copyright 2008-2010 Intel Corporation |
| 5 | * Author: Sreedhara DS (sreedhara.ds@intel.com) |
| 6 | * |
| 7 | * This program is free software; you can redistribute it and/or |
| 8 | * modify it under the terms of the GNU General Public License |
| 9 | * as published by the Free Software Foundation; version 2 |
| 10 | * of the License. |
| 11 | * |
| 12 | * SCU runing in ARC processor communicates with other entity running in IA |
| 13 | * core through IPC mechanism which in turn messaging between IA core ad SCU. |
| 14 | * SCU has two IPC mechanism IPC-1 and IPC-2. IPC-1 is used between IA32 and |
| 15 | * SCU where IPC-2 is used between P-Unit and SCU. This driver delas with |
| 16 | * IPC-1 Driver provides an API for power control unit registers (e.g. MSIC) |
| 17 | * along with other APIs. |
| 18 | */ |
| 19 | #include <linux/delay.h> |
| 20 | #include <linux/errno.h> |
| 21 | #include <linux/init.h> |
| 22 | #include <linux/sysdev.h> |
| 23 | #include <linux/pm.h> |
| 24 | #include <linux/pci.h> |
| 25 | #include <linux/interrupt.h> |
Sreedhara DS | 14d10f0 | 2010-07-26 10:02:25 +0100 | [diff] [blame] | 26 | #include <asm/mrst.h> |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 27 | #include <asm/intel_scu_ipc.h> |
| 28 | |
| 29 | /* IPC defines the following message types */ |
| 30 | #define IPCMSG_WATCHDOG_TIMER 0xF8 /* Set Kernel Watchdog Threshold */ |
| 31 | #define IPCMSG_BATTERY 0xEF /* Coulomb Counter Accumulator */ |
| 32 | #define IPCMSG_FW_UPDATE 0xFE /* Firmware update */ |
| 33 | #define IPCMSG_PCNTRL 0xFF /* Power controller unit read/write */ |
| 34 | #define IPCMSG_FW_REVISION 0xF4 /* Get firmware revision */ |
| 35 | |
| 36 | /* Command id associated with message IPCMSG_PCNTRL */ |
| 37 | #define IPC_CMD_PCNTRL_W 0 /* Register write */ |
| 38 | #define IPC_CMD_PCNTRL_R 1 /* Register read */ |
| 39 | #define IPC_CMD_PCNTRL_M 2 /* Register read-modify-write */ |
| 40 | |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 41 | /* |
| 42 | * IPC register summary |
| 43 | * |
| 44 | * IPC register blocks are memory mapped at fixed address of 0xFF11C000 |
| 45 | * To read or write information to the SCU, driver writes to IPC-1 memory |
| 46 | * mapped registers (base address 0xFF11C000). The following is the IPC |
| 47 | * mechanism |
| 48 | * |
| 49 | * 1. IA core cDMI interface claims this transaction and converts it to a |
| 50 | * Transaction Layer Packet (TLP) message which is sent across the cDMI. |
| 51 | * |
| 52 | * 2. South Complex cDMI block receives this message and writes it to |
| 53 | * the IPC-1 register block, causing an interrupt to the SCU |
| 54 | * |
| 55 | * 3. SCU firmware decodes this interrupt and IPC message and the appropriate |
| 56 | * message handler is called within firmware. |
| 57 | */ |
| 58 | |
| 59 | #define IPC_BASE_ADDR 0xFF11C000 /* IPC1 base register address */ |
| 60 | #define IPC_MAX_ADDR 0x100 /* Maximum IPC regisers */ |
Arjan van de Ven | 51cd525 | 2010-07-26 10:04:24 +0100 | [diff] [blame^] | 61 | #define IPC_WWBUF_SIZE 20 /* IPC Write buffer Size */ |
| 62 | #define IPC_RWBUF_SIZE 20 /* IPC Read buffer Size */ |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 63 | #define IPC_I2C_BASE 0xFF12B000 /* I2C control register base address */ |
| 64 | #define IPC_I2C_MAX_ADDR 0x10 /* Maximum I2C regisers */ |
| 65 | |
| 66 | static int ipc_probe(struct pci_dev *dev, const struct pci_device_id *id); |
| 67 | static void ipc_remove(struct pci_dev *pdev); |
| 68 | |
| 69 | struct intel_scu_ipc_dev { |
| 70 | struct pci_dev *pdev; |
| 71 | void __iomem *ipc_base; |
| 72 | void __iomem *i2c_base; |
| 73 | }; |
| 74 | |
| 75 | static struct intel_scu_ipc_dev ipcdev; /* Only one for now */ |
| 76 | |
Sreedhara DS | 14d10f0 | 2010-07-26 10:02:25 +0100 | [diff] [blame] | 77 | static int platform; /* Platform type */ |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 78 | |
| 79 | /* |
| 80 | * IPC Read Buffer (Read Only): |
| 81 | * 16 byte buffer for receiving data from SCU, if IPC command |
| 82 | * processing results in response data |
| 83 | */ |
| 84 | #define IPC_READ_BUFFER 0x90 |
| 85 | |
| 86 | #define IPC_I2C_CNTRL_ADDR 0 |
| 87 | #define I2C_DATA_ADDR 0x04 |
| 88 | |
| 89 | static DEFINE_MUTEX(ipclock); /* lock used to prevent multiple call to SCU */ |
| 90 | |
| 91 | /* |
| 92 | * Command Register (Write Only): |
| 93 | * A write to this register results in an interrupt to the SCU core processor |
| 94 | * Format: |
| 95 | * |rfu2(8) | size(8) | command id(4) | rfu1(3) | ioc(1) | command(8)| |
| 96 | */ |
| 97 | static inline void ipc_command(u32 cmd) /* Send ipc command */ |
| 98 | { |
| 99 | writel(cmd, ipcdev.ipc_base); |
| 100 | } |
| 101 | |
| 102 | /* |
| 103 | * IPC Write Buffer (Write Only): |
| 104 | * 16-byte buffer for sending data associated with IPC command to |
| 105 | * SCU. Size of the data is specified in the IPC_COMMAND_REG register |
| 106 | */ |
| 107 | static inline void ipc_data_writel(u32 data, u32 offset) /* Write ipc data */ |
| 108 | { |
| 109 | writel(data, ipcdev.ipc_base + 0x80 + offset); |
| 110 | } |
| 111 | |
| 112 | /* |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 113 | * Status Register (Read Only): |
| 114 | * Driver will read this register to get the ready/busy status of the IPC |
| 115 | * block and error status of the IPC command that was just processed by SCU |
| 116 | * Format: |
| 117 | * |rfu3(8)|error code(8)|initiator id(8)|cmd id(4)|rfu1(2)|error(1)|busy(1)| |
| 118 | */ |
| 119 | |
| 120 | static inline u8 ipc_read_status(void) |
| 121 | { |
| 122 | return __raw_readl(ipcdev.ipc_base + 0x04); |
| 123 | } |
| 124 | |
| 125 | static inline u8 ipc_data_readb(u32 offset) /* Read ipc byte data */ |
| 126 | { |
| 127 | return readb(ipcdev.ipc_base + IPC_READ_BUFFER + offset); |
| 128 | } |
| 129 | |
Sreedhara DS | e3359fd | 2010-07-26 10:02:46 +0100 | [diff] [blame] | 130 | static inline u32 ipc_data_readl(u32 offset) /* Read ipc u32 data */ |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 131 | { |
| 132 | return readl(ipcdev.ipc_base + IPC_READ_BUFFER + offset); |
| 133 | } |
| 134 | |
| 135 | static inline int busy_loop(void) /* Wait till scu status is busy */ |
| 136 | { |
| 137 | u32 status = 0; |
| 138 | u32 loop_count = 0; |
| 139 | |
| 140 | status = ipc_read_status(); |
| 141 | while (status & 1) { |
| 142 | udelay(1); /* scu processing time is in few u secods */ |
| 143 | status = ipc_read_status(); |
| 144 | loop_count++; |
| 145 | /* break if scu doesn't reset busy bit after huge retry */ |
| 146 | if (loop_count > 100000) { |
| 147 | dev_err(&ipcdev.pdev->dev, "IPC timed out"); |
| 148 | return -ETIMEDOUT; |
| 149 | } |
| 150 | } |
| 151 | return (status >> 1) & 1; |
| 152 | } |
| 153 | |
| 154 | /* Read/Write power control(PMIC in Langwell, MSIC in PenWell) registers */ |
| 155 | static int pwr_reg_rdwr(u16 *addr, u8 *data, u32 count, u32 op, u32 id) |
| 156 | { |
| 157 | int nc; |
| 158 | u32 offset = 0; |
| 159 | u32 err = 0; |
Sreedhara DS | e3359fd | 2010-07-26 10:02:46 +0100 | [diff] [blame] | 160 | u8 cbuf[IPC_WWBUF_SIZE] = { }; |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 161 | u32 *wbuf = (u32 *)&cbuf; |
| 162 | |
| 163 | mutex_lock(&ipclock); |
Sreedhara DS | e3359fd | 2010-07-26 10:02:46 +0100 | [diff] [blame] | 164 | |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 165 | if (ipcdev.pdev == NULL) { |
| 166 | mutex_unlock(&ipclock); |
| 167 | return -ENODEV; |
| 168 | } |
| 169 | |
Alan Cox | 9dd3ade | 2010-07-26 10:03:58 +0100 | [diff] [blame] | 170 | if (platform != MRST_CPU_CHIP_PENWELL) { |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 171 | /* Entry is 4 bytes for read/write, 5 bytes for read modify */ |
Sreedhara DS | e3359fd | 2010-07-26 10:02:46 +0100 | [diff] [blame] | 172 | for (nc = 0; nc < count; nc++, offset += 3) { |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 173 | cbuf[offset] = addr[nc]; |
| 174 | cbuf[offset + 1] = addr[nc] >> 8; |
| 175 | if (id != IPC_CMD_PCNTRL_R) |
| 176 | cbuf[offset + 2] = data[nc]; |
| 177 | if (id == IPC_CMD_PCNTRL_M) { |
| 178 | cbuf[offset + 3] = data[nc + 1]; |
| 179 | offset += 1; |
| 180 | } |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 181 | } |
| 182 | for (nc = 0, offset = 0; nc < count; nc++, offset += 4) |
| 183 | ipc_data_writel(wbuf[nc], offset); /* Write wbuff */ |
| 184 | |
Sreedhara DS | e3359fd | 2010-07-26 10:02:46 +0100 | [diff] [blame] | 185 | if (id != IPC_CMD_PCNTRL_M) |
| 186 | ipc_command((count*4) << 16 | id << 12 | 0 << 8 | op); |
| 187 | else |
| 188 | ipc_command((count*5) << 16 | id << 12 | 0 << 8 | op); |
| 189 | |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 190 | } else { |
Sreedhara DS | e3359fd | 2010-07-26 10:02:46 +0100 | [diff] [blame] | 191 | for (nc = 0; nc < count; nc++, offset += 2) { |
| 192 | cbuf[offset] = addr[nc]; |
| 193 | cbuf[offset + 1] = addr[nc] >> 8; |
| 194 | } |
| 195 | |
| 196 | if (id == IPC_CMD_PCNTRL_R) { |
| 197 | for (nc = 0, offset = 0; nc < count; nc++, offset += 4) |
| 198 | ipc_data_writel(wbuf[nc], offset); |
| 199 | ipc_command((count*2) << 16 | id << 12 | 0 << 8 | op); |
| 200 | } else if (id == IPC_CMD_PCNTRL_W) { |
| 201 | for (nc = 0; nc < count; nc++, offset += 1) |
| 202 | cbuf[offset] = data[nc]; |
| 203 | for (nc = 0, offset = 0; nc < count; nc++, offset += 4) |
| 204 | ipc_data_writel(wbuf[nc], offset); |
| 205 | ipc_command((count*3) << 16 | id << 12 | 0 << 8 | op); |
| 206 | } else if (id == IPC_CMD_PCNTRL_M) { |
| 207 | cbuf[offset] = data[0]; |
| 208 | cbuf[offset + 1] = data[1]; |
| 209 | ipc_data_writel(wbuf[0], 0); /* Write wbuff */ |
| 210 | ipc_command(4 << 16 | id << 12 | 0 << 8 | op); |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 211 | } |
| 212 | } |
| 213 | |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 214 | err = busy_loop(); |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 215 | if (id == IPC_CMD_PCNTRL_R) { /* Read rbuf */ |
| 216 | /* Workaround: values are read as 0 without memcpy_fromio */ |
Sreedhara DS | e3359fd | 2010-07-26 10:02:46 +0100 | [diff] [blame] | 217 | memcpy_fromio(cbuf, ipcdev.ipc_base + 0x90, 16); |
Alan Cox | 9dd3ade | 2010-07-26 10:03:58 +0100 | [diff] [blame] | 218 | if (platform != MRST_CPU_CHIP_PENWELL) { |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 219 | for (nc = 0, offset = 2; nc < count; nc++, offset += 3) |
| 220 | data[nc] = ipc_data_readb(offset); |
| 221 | } else { |
| 222 | for (nc = 0; nc < count; nc++) |
| 223 | data[nc] = ipc_data_readb(nc); |
| 224 | } |
| 225 | } |
| 226 | mutex_unlock(&ipclock); |
| 227 | return err; |
| 228 | } |
| 229 | |
| 230 | /** |
| 231 | * intel_scu_ipc_ioread8 - read a word via the SCU |
| 232 | * @addr: register on SCU |
| 233 | * @data: return pointer for read byte |
| 234 | * |
| 235 | * Read a single register. Returns 0 on success or an error code. All |
| 236 | * locking between SCU accesses is handled for the caller. |
| 237 | * |
| 238 | * This function may sleep. |
| 239 | */ |
| 240 | int intel_scu_ipc_ioread8(u16 addr, u8 *data) |
| 241 | { |
| 242 | return pwr_reg_rdwr(&addr, data, 1, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_R); |
| 243 | } |
| 244 | EXPORT_SYMBOL(intel_scu_ipc_ioread8); |
| 245 | |
| 246 | /** |
| 247 | * intel_scu_ipc_ioread16 - read a word via the SCU |
| 248 | * @addr: register on SCU |
| 249 | * @data: return pointer for read word |
| 250 | * |
| 251 | * Read a register pair. Returns 0 on success or an error code. All |
| 252 | * locking between SCU accesses is handled for the caller. |
| 253 | * |
| 254 | * This function may sleep. |
| 255 | */ |
| 256 | int intel_scu_ipc_ioread16(u16 addr, u16 *data) |
| 257 | { |
| 258 | u16 x[2] = {addr, addr + 1 }; |
| 259 | return pwr_reg_rdwr(x, (u8 *)data, 2, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_R); |
| 260 | } |
| 261 | EXPORT_SYMBOL(intel_scu_ipc_ioread16); |
| 262 | |
| 263 | /** |
| 264 | * intel_scu_ipc_ioread32 - read a dword via the SCU |
| 265 | * @addr: register on SCU |
| 266 | * @data: return pointer for read dword |
| 267 | * |
| 268 | * Read four registers. Returns 0 on success or an error code. All |
| 269 | * locking between SCU accesses is handled for the caller. |
| 270 | * |
| 271 | * This function may sleep. |
| 272 | */ |
| 273 | int intel_scu_ipc_ioread32(u16 addr, u32 *data) |
| 274 | { |
| 275 | u16 x[4] = {addr, addr + 1, addr + 2, addr + 3}; |
| 276 | return pwr_reg_rdwr(x, (u8 *)data, 4, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_R); |
| 277 | } |
| 278 | EXPORT_SYMBOL(intel_scu_ipc_ioread32); |
| 279 | |
| 280 | /** |
| 281 | * intel_scu_ipc_iowrite8 - write a byte via the SCU |
| 282 | * @addr: register on SCU |
| 283 | * @data: byte to write |
| 284 | * |
| 285 | * Write a single register. Returns 0 on success or an error code. All |
| 286 | * locking between SCU accesses is handled for the caller. |
| 287 | * |
| 288 | * This function may sleep. |
| 289 | */ |
| 290 | int intel_scu_ipc_iowrite8(u16 addr, u8 data) |
| 291 | { |
| 292 | return pwr_reg_rdwr(&addr, &data, 1, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_W); |
| 293 | } |
| 294 | EXPORT_SYMBOL(intel_scu_ipc_iowrite8); |
| 295 | |
| 296 | /** |
| 297 | * intel_scu_ipc_iowrite16 - write a word via the SCU |
| 298 | * @addr: register on SCU |
| 299 | * @data: word to write |
| 300 | * |
| 301 | * Write two registers. Returns 0 on success or an error code. All |
| 302 | * locking between SCU accesses is handled for the caller. |
| 303 | * |
| 304 | * This function may sleep. |
| 305 | */ |
| 306 | int intel_scu_ipc_iowrite16(u16 addr, u16 data) |
| 307 | { |
| 308 | u16 x[2] = {addr, addr + 1 }; |
| 309 | return pwr_reg_rdwr(x, (u8 *)&data, 2, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_W); |
| 310 | } |
| 311 | EXPORT_SYMBOL(intel_scu_ipc_iowrite16); |
| 312 | |
| 313 | /** |
| 314 | * intel_scu_ipc_iowrite32 - write a dword via the SCU |
| 315 | * @addr: register on SCU |
| 316 | * @data: dword to write |
| 317 | * |
| 318 | * Write four registers. Returns 0 on success or an error code. All |
| 319 | * locking between SCU accesses is handled for the caller. |
| 320 | * |
| 321 | * This function may sleep. |
| 322 | */ |
| 323 | int intel_scu_ipc_iowrite32(u16 addr, u32 data) |
| 324 | { |
| 325 | u16 x[4] = {addr, addr + 1, addr + 2, addr + 3}; |
| 326 | return pwr_reg_rdwr(x, (u8 *)&data, 4, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_W); |
| 327 | } |
| 328 | EXPORT_SYMBOL(intel_scu_ipc_iowrite32); |
| 329 | |
| 330 | /** |
| 331 | * intel_scu_ipc_readvv - read a set of registers |
| 332 | * @addr: register list |
| 333 | * @data: bytes to return |
| 334 | * @len: length of array |
| 335 | * |
| 336 | * Read registers. Returns 0 on success or an error code. All |
| 337 | * locking between SCU accesses is handled for the caller. |
| 338 | * |
| 339 | * The largest array length permitted by the hardware is 5 items. |
| 340 | * |
| 341 | * This function may sleep. |
| 342 | */ |
| 343 | int intel_scu_ipc_readv(u16 *addr, u8 *data, int len) |
| 344 | { |
| 345 | return pwr_reg_rdwr(addr, data, len, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_R); |
| 346 | } |
| 347 | EXPORT_SYMBOL(intel_scu_ipc_readv); |
| 348 | |
| 349 | /** |
| 350 | * intel_scu_ipc_writev - write a set of registers |
| 351 | * @addr: register list |
| 352 | * @data: bytes to write |
| 353 | * @len: length of array |
| 354 | * |
| 355 | * Write registers. Returns 0 on success or an error code. All |
| 356 | * locking between SCU accesses is handled for the caller. |
| 357 | * |
| 358 | * The largest array length permitted by the hardware is 5 items. |
| 359 | * |
| 360 | * This function may sleep. |
| 361 | * |
| 362 | */ |
| 363 | int intel_scu_ipc_writev(u16 *addr, u8 *data, int len) |
| 364 | { |
| 365 | return pwr_reg_rdwr(addr, data, len, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_W); |
| 366 | } |
| 367 | EXPORT_SYMBOL(intel_scu_ipc_writev); |
| 368 | |
| 369 | |
| 370 | /** |
| 371 | * intel_scu_ipc_update_register - r/m/w a register |
| 372 | * @addr: register address |
| 373 | * @bits: bits to update |
| 374 | * @mask: mask of bits to update |
| 375 | * |
| 376 | * Read-modify-write power control unit register. The first data argument |
| 377 | * must be register value and second is mask value |
| 378 | * mask is a bitmap that indicates which bits to update. |
| 379 | * 0 = masked. Don't modify this bit, 1 = modify this bit. |
| 380 | * returns 0 on success or an error code. |
| 381 | * |
| 382 | * This function may sleep. Locking between SCU accesses is handled |
| 383 | * for the caller. |
| 384 | */ |
| 385 | int intel_scu_ipc_update_register(u16 addr, u8 bits, u8 mask) |
| 386 | { |
| 387 | u8 data[2] = { bits, mask }; |
| 388 | return pwr_reg_rdwr(&addr, data, 1, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_M); |
| 389 | } |
| 390 | EXPORT_SYMBOL(intel_scu_ipc_update_register); |
| 391 | |
| 392 | /** |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 393 | * intel_scu_ipc_simple_command - send a simple command |
| 394 | * @cmd: command |
| 395 | * @sub: sub type |
| 396 | * |
| 397 | * Issue a simple command to the SCU. Do not use this interface if |
| 398 | * you must then access data as any data values may be overwritten |
| 399 | * by another SCU access by the time this function returns. |
| 400 | * |
| 401 | * This function may sleep. Locking for SCU accesses is handled for |
| 402 | * the caller. |
| 403 | */ |
| 404 | int intel_scu_ipc_simple_command(int cmd, int sub) |
| 405 | { |
| 406 | u32 err = 0; |
| 407 | |
| 408 | mutex_lock(&ipclock); |
| 409 | if (ipcdev.pdev == NULL) { |
| 410 | mutex_unlock(&ipclock); |
| 411 | return -ENODEV; |
| 412 | } |
Sreedhara DS | b4fd4f8 | 2010-07-19 09:37:42 +0100 | [diff] [blame] | 413 | ipc_command(sub << 12 | cmd); |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 414 | err = busy_loop(); |
| 415 | mutex_unlock(&ipclock); |
| 416 | return err; |
| 417 | } |
| 418 | EXPORT_SYMBOL(intel_scu_ipc_simple_command); |
| 419 | |
| 420 | /** |
| 421 | * intel_scu_ipc_command - command with data |
| 422 | * @cmd: command |
| 423 | * @sub: sub type |
| 424 | * @in: input data |
Sreedhara DS | b4fd4f8 | 2010-07-19 09:37:42 +0100 | [diff] [blame] | 425 | * @inlen: input length in dwords |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 426 | * @out: output data |
Sreedhara DS | b4fd4f8 | 2010-07-19 09:37:42 +0100 | [diff] [blame] | 427 | * @outlein: output length in dwords |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 428 | * |
| 429 | * Issue a command to the SCU which involves data transfers. Do the |
| 430 | * data copies under the lock but leave it for the caller to interpret |
| 431 | */ |
| 432 | |
| 433 | int intel_scu_ipc_command(int cmd, int sub, u32 *in, int inlen, |
| 434 | u32 *out, int outlen) |
| 435 | { |
| 436 | u32 err = 0; |
| 437 | int i = 0; |
| 438 | |
| 439 | mutex_lock(&ipclock); |
| 440 | if (ipcdev.pdev == NULL) { |
| 441 | mutex_unlock(&ipclock); |
| 442 | return -ENODEV; |
| 443 | } |
| 444 | |
| 445 | for (i = 0; i < inlen; i++) |
| 446 | ipc_data_writel(*in++, 4 * i); |
| 447 | |
Sreedhara DS | b4fd4f8 | 2010-07-19 09:37:42 +0100 | [diff] [blame] | 448 | ipc_command((sub << 12) | cmd | (inlen << 18)); |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 449 | err = busy_loop(); |
| 450 | |
| 451 | for (i = 0; i < outlen; i++) |
| 452 | *out++ = ipc_data_readl(4 * i); |
| 453 | |
| 454 | mutex_unlock(&ipclock); |
| 455 | return err; |
| 456 | } |
| 457 | EXPORT_SYMBOL(intel_scu_ipc_command); |
| 458 | |
| 459 | /*I2C commands */ |
| 460 | #define IPC_I2C_WRITE 1 /* I2C Write command */ |
| 461 | #define IPC_I2C_READ 2 /* I2C Read command */ |
| 462 | |
| 463 | /** |
| 464 | * intel_scu_ipc_i2c_cntrl - I2C read/write operations |
| 465 | * @addr: I2C address + command bits |
| 466 | * @data: data to read/write |
| 467 | * |
| 468 | * Perform an an I2C read/write operation via the SCU. All locking is |
| 469 | * handled for the caller. This function may sleep. |
| 470 | * |
| 471 | * Returns an error code or 0 on success. |
| 472 | * |
| 473 | * This has to be in the IPC driver for the locking. |
| 474 | */ |
| 475 | int intel_scu_ipc_i2c_cntrl(u32 addr, u32 *data) |
| 476 | { |
| 477 | u32 cmd = 0; |
| 478 | |
| 479 | mutex_lock(&ipclock); |
Sreedhara DS | b4fd4f8 | 2010-07-19 09:37:42 +0100 | [diff] [blame] | 480 | if (ipcdev.pdev == NULL) { |
| 481 | mutex_unlock(&ipclock); |
| 482 | return -ENODEV; |
| 483 | } |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 484 | cmd = (addr >> 24) & 0xFF; |
| 485 | if (cmd == IPC_I2C_READ) { |
| 486 | writel(addr, ipcdev.i2c_base + IPC_I2C_CNTRL_ADDR); |
| 487 | /* Write not getting updated without delay */ |
| 488 | mdelay(1); |
| 489 | *data = readl(ipcdev.i2c_base + I2C_DATA_ADDR); |
| 490 | } else if (cmd == IPC_I2C_WRITE) { |
| 491 | writel(addr, ipcdev.i2c_base + I2C_DATA_ADDR); |
| 492 | mdelay(1); |
| 493 | writel(addr, ipcdev.i2c_base + IPC_I2C_CNTRL_ADDR); |
| 494 | } else { |
| 495 | dev_err(&ipcdev.pdev->dev, |
| 496 | "intel_scu_ipc: I2C INVALID_CMD = 0x%x\n", cmd); |
| 497 | |
| 498 | mutex_unlock(&ipclock); |
| 499 | return -1; |
| 500 | } |
| 501 | mutex_unlock(&ipclock); |
| 502 | return 0; |
| 503 | } |
| 504 | EXPORT_SYMBOL(intel_scu_ipc_i2c_cntrl); |
| 505 | |
| 506 | #define IPC_FW_LOAD_ADDR 0xFFFC0000 /* Storage location for FW image */ |
| 507 | #define IPC_FW_UPDATE_MBOX_ADDR 0xFFFFDFF4 /* Mailbox between ipc and scu */ |
| 508 | #define IPC_MAX_FW_SIZE 262144 /* 256K storage size for loading the FW image */ |
| 509 | #define IPC_FW_MIP_HEADER_SIZE 2048 /* Firmware MIP header size */ |
| 510 | /* IPC inform SCU to get ready for update process */ |
| 511 | #define IPC_CMD_FW_UPDATE_READY 0x10FE |
| 512 | /* IPC inform SCU to go for update process */ |
| 513 | #define IPC_CMD_FW_UPDATE_GO 0x20FE |
| 514 | /* Status code for fw update */ |
| 515 | #define IPC_FW_UPDATE_SUCCESS 0x444f4e45 /* Status code 'DONE' */ |
| 516 | #define IPC_FW_UPDATE_BADN 0x4241444E /* Status code 'BADN' */ |
| 517 | #define IPC_FW_TXHIGH 0x54784849 /* Status code 'IPC_FW_TXHIGH' */ |
| 518 | #define IPC_FW_TXLOW 0x54784c4f /* Status code 'IPC_FW_TXLOW' */ |
| 519 | |
| 520 | struct fw_update_mailbox { |
| 521 | u32 status; |
| 522 | u32 scu_flag; |
| 523 | u32 driver_flag; |
| 524 | }; |
| 525 | |
| 526 | |
| 527 | /** |
| 528 | * intel_scu_ipc_fw_update - Firmware update utility |
| 529 | * @buffer: firmware buffer |
| 530 | * @length: size of firmware buffer |
| 531 | * |
| 532 | * This function provides an interface to load the firmware into |
| 533 | * the SCU. Returns 0 on success or -1 on failure |
| 534 | */ |
| 535 | int intel_scu_ipc_fw_update(u8 *buffer, u32 length) |
| 536 | { |
| 537 | void __iomem *fw_update_base; |
| 538 | struct fw_update_mailbox __iomem *mailbox = NULL; |
| 539 | int retry_cnt = 0; |
| 540 | u32 status; |
| 541 | |
| 542 | mutex_lock(&ipclock); |
| 543 | fw_update_base = ioremap_nocache(IPC_FW_LOAD_ADDR, (128*1024)); |
| 544 | if (fw_update_base == NULL) { |
| 545 | mutex_unlock(&ipclock); |
| 546 | return -ENOMEM; |
| 547 | } |
| 548 | mailbox = ioremap_nocache(IPC_FW_UPDATE_MBOX_ADDR, |
| 549 | sizeof(struct fw_update_mailbox)); |
| 550 | if (mailbox == NULL) { |
| 551 | iounmap(fw_update_base); |
| 552 | mutex_unlock(&ipclock); |
| 553 | return -ENOMEM; |
| 554 | } |
| 555 | |
| 556 | ipc_command(IPC_CMD_FW_UPDATE_READY); |
| 557 | |
| 558 | /* Intitialize mailbox */ |
| 559 | writel(0, &mailbox->status); |
| 560 | writel(0, &mailbox->scu_flag); |
| 561 | writel(0, &mailbox->driver_flag); |
| 562 | |
| 563 | /* Driver copies the 2KB MIP header to SRAM at 0xFFFC0000*/ |
| 564 | memcpy_toio(fw_update_base, buffer, 0x800); |
| 565 | |
| 566 | /* Driver sends "FW Update" IPC command (CMD_ID 0xFE; MSG_ID 0x02). |
| 567 | * Upon receiving this command, SCU will write the 2K MIP header |
| 568 | * from 0xFFFC0000 into NAND. |
| 569 | * SCU will write a status code into the Mailbox, and then set scu_flag. |
| 570 | */ |
| 571 | |
| 572 | ipc_command(IPC_CMD_FW_UPDATE_GO); |
| 573 | |
| 574 | /*Driver stalls until scu_flag is set */ |
| 575 | while (readl(&mailbox->scu_flag) != 1) { |
| 576 | rmb(); |
| 577 | mdelay(1); |
| 578 | } |
| 579 | |
| 580 | /* Driver checks Mailbox status. |
| 581 | * If the status is 'BADN', then abort (bad NAND). |
| 582 | * If the status is 'IPC_FW_TXLOW', then continue. |
| 583 | */ |
| 584 | while (readl(&mailbox->status) != IPC_FW_TXLOW) { |
| 585 | rmb(); |
| 586 | mdelay(10); |
| 587 | } |
| 588 | mdelay(10); |
| 589 | |
| 590 | update_retry: |
| 591 | if (retry_cnt > 5) |
| 592 | goto update_end; |
| 593 | |
| 594 | if (readl(&mailbox->status) != IPC_FW_TXLOW) |
| 595 | goto update_end; |
| 596 | buffer = buffer + 0x800; |
| 597 | memcpy_toio(fw_update_base, buffer, 0x20000); |
| 598 | writel(1, &mailbox->driver_flag); |
| 599 | while (readl(&mailbox->scu_flag) == 1) { |
| 600 | rmb(); |
| 601 | mdelay(1); |
| 602 | } |
| 603 | |
| 604 | /* check for 'BADN' */ |
| 605 | if (readl(&mailbox->status) == IPC_FW_UPDATE_BADN) |
| 606 | goto update_end; |
| 607 | |
| 608 | while (readl(&mailbox->status) != IPC_FW_TXHIGH) { |
| 609 | rmb(); |
| 610 | mdelay(10); |
| 611 | } |
| 612 | mdelay(10); |
| 613 | |
| 614 | if (readl(&mailbox->status) != IPC_FW_TXHIGH) |
| 615 | goto update_end; |
| 616 | |
| 617 | buffer = buffer + 0x20000; |
| 618 | memcpy_toio(fw_update_base, buffer, 0x20000); |
| 619 | writel(0, &mailbox->driver_flag); |
| 620 | |
| 621 | while (mailbox->scu_flag == 0) { |
| 622 | rmb(); |
| 623 | mdelay(1); |
| 624 | } |
| 625 | |
| 626 | /* check for 'BADN' */ |
| 627 | if (readl(&mailbox->status) == IPC_FW_UPDATE_BADN) |
| 628 | goto update_end; |
| 629 | |
| 630 | if (readl(&mailbox->status) == IPC_FW_TXLOW) { |
| 631 | ++retry_cnt; |
| 632 | goto update_retry; |
| 633 | } |
| 634 | |
| 635 | update_end: |
| 636 | status = readl(&mailbox->status); |
| 637 | |
| 638 | iounmap(fw_update_base); |
| 639 | iounmap(mailbox); |
| 640 | mutex_unlock(&ipclock); |
| 641 | |
| 642 | if (status == IPC_FW_UPDATE_SUCCESS) |
| 643 | return 0; |
| 644 | return -1; |
| 645 | } |
| 646 | EXPORT_SYMBOL(intel_scu_ipc_fw_update); |
| 647 | |
| 648 | /* |
| 649 | * Interrupt handler gets called when ioc bit of IPC_COMMAND_REG set to 1 |
| 650 | * When ioc bit is set to 1, caller api must wait for interrupt handler called |
| 651 | * which in turn unlocks the caller api. Currently this is not used |
| 652 | * |
| 653 | * This is edge triggered so we need take no action to clear anything |
| 654 | */ |
| 655 | static irqreturn_t ioc(int irq, void *dev_id) |
| 656 | { |
| 657 | return IRQ_HANDLED; |
| 658 | } |
| 659 | |
| 660 | /** |
| 661 | * ipc_probe - probe an Intel SCU IPC |
| 662 | * @dev: the PCI device matching |
| 663 | * @id: entry in the match table |
| 664 | * |
| 665 | * Enable and install an intel SCU IPC. This appears in the PCI space |
| 666 | * but uses some hard coded addresses as well. |
| 667 | */ |
| 668 | static int ipc_probe(struct pci_dev *dev, const struct pci_device_id *id) |
| 669 | { |
| 670 | int err; |
| 671 | resource_size_t pci_resource; |
| 672 | |
| 673 | if (ipcdev.pdev) /* We support only one SCU */ |
| 674 | return -EBUSY; |
| 675 | |
| 676 | ipcdev.pdev = pci_dev_get(dev); |
| 677 | |
| 678 | err = pci_enable_device(dev); |
| 679 | if (err) |
| 680 | return err; |
| 681 | |
| 682 | err = pci_request_regions(dev, "intel_scu_ipc"); |
| 683 | if (err) |
| 684 | return err; |
| 685 | |
| 686 | pci_resource = pci_resource_start(dev, 0); |
| 687 | if (!pci_resource) |
| 688 | return -ENOMEM; |
| 689 | |
| 690 | if (request_irq(dev->irq, ioc, 0, "intel_scu_ipc", &ipcdev)) |
| 691 | return -EBUSY; |
| 692 | |
| 693 | ipcdev.ipc_base = ioremap_nocache(IPC_BASE_ADDR, IPC_MAX_ADDR); |
| 694 | if (!ipcdev.ipc_base) |
| 695 | return -ENOMEM; |
| 696 | |
| 697 | ipcdev.i2c_base = ioremap_nocache(IPC_I2C_BASE, IPC_I2C_MAX_ADDR); |
| 698 | if (!ipcdev.i2c_base) { |
| 699 | iounmap(ipcdev.ipc_base); |
| 700 | return -ENOMEM; |
| 701 | } |
| 702 | return 0; |
| 703 | } |
| 704 | |
| 705 | /** |
| 706 | * ipc_remove - remove a bound IPC device |
| 707 | * @pdev: PCI device |
| 708 | * |
| 709 | * In practice the SCU is not removable but this function is also |
| 710 | * called for each device on a module unload or cleanup which is the |
| 711 | * path that will get used. |
| 712 | * |
| 713 | * Free up the mappings and release the PCI resources |
| 714 | */ |
| 715 | static void ipc_remove(struct pci_dev *pdev) |
| 716 | { |
| 717 | free_irq(pdev->irq, &ipcdev); |
| 718 | pci_release_regions(pdev); |
| 719 | pci_dev_put(ipcdev.pdev); |
| 720 | iounmap(ipcdev.ipc_base); |
| 721 | iounmap(ipcdev.i2c_base); |
| 722 | ipcdev.pdev = NULL; |
| 723 | } |
| 724 | |
| 725 | static const struct pci_device_id pci_ids[] = { |
| 726 | {PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x080e)}, |
Sreedhara DS | e3359fd | 2010-07-26 10:02:46 +0100 | [diff] [blame] | 727 | {PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x082a)}, |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 728 | { 0,} |
| 729 | }; |
| 730 | MODULE_DEVICE_TABLE(pci, pci_ids); |
| 731 | |
| 732 | static struct pci_driver ipc_driver = { |
| 733 | .name = "intel_scu_ipc", |
| 734 | .id_table = pci_ids, |
| 735 | .probe = ipc_probe, |
| 736 | .remove = ipc_remove, |
| 737 | }; |
| 738 | |
| 739 | |
| 740 | static int __init intel_scu_ipc_init(void) |
| 741 | { |
Alan Cox | 9dd3ade | 2010-07-26 10:03:58 +0100 | [diff] [blame] | 742 | platform = mrst_identify_cpu(); |
| 743 | if (platform == 0) |
| 744 | return -ENODEV; |
Sreedhara DS | 9a58a33 | 2010-04-26 18:13:05 +0100 | [diff] [blame] | 745 | return pci_register_driver(&ipc_driver); |
| 746 | } |
| 747 | |
| 748 | static void __exit intel_scu_ipc_exit(void) |
| 749 | { |
| 750 | pci_unregister_driver(&ipc_driver); |
| 751 | } |
| 752 | |
| 753 | MODULE_AUTHOR("Sreedhara DS <sreedhara.ds@intel.com>"); |
| 754 | MODULE_DESCRIPTION("Intel SCU IPC driver"); |
| 755 | MODULE_LICENSE("GPL"); |
| 756 | |
| 757 | module_init(intel_scu_ipc_init); |
| 758 | module_exit(intel_scu_ipc_exit); |