intel_scu_ipc.c 20 KB

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