intel_scu_ipc.c 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754
  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. return (status >> 1) & 1;
  133. }
  134. /* Read/Write power control(PMIC in Langwell, MSIC in PenWell) registers */
  135. static int pwr_reg_rdwr(u16 *addr, u8 *data, u32 count, u32 op, u32 id)
  136. {
  137. int i, nc, bytes, d;
  138. u32 offset = 0;
  139. u32 err = 0;
  140. u8 cbuf[IPC_WWBUF_SIZE] = { };
  141. u32 *wbuf = (u32 *)&cbuf;
  142. mutex_lock(&ipclock);
  143. memset(cbuf, 0, sizeof(cbuf));
  144. if (ipcdev.pdev == NULL) {
  145. mutex_unlock(&ipclock);
  146. return -ENODEV;
  147. }
  148. if (platform != MRST_CPU_CHIP_PENWELL) {
  149. bytes = 0;
  150. d = 0;
  151. for (i = 0; i < count; i++) {
  152. cbuf[bytes++] = addr[i];
  153. cbuf[bytes++] = addr[i] >> 8;
  154. if (id != IPC_CMD_PCNTRL_R)
  155. cbuf[bytes++] = data[d++];
  156. if (id == IPC_CMD_PCNTRL_M)
  157. cbuf[bytes++] = data[d++];
  158. }
  159. for (i = 0; i < bytes; i += 4)
  160. ipc_data_writel(wbuf[i/4], i);
  161. ipc_command(bytes << 16 | id << 12 | 0 << 8 | op);
  162. } else {
  163. for (nc = 0; nc < count; nc++, offset += 2) {
  164. cbuf[offset] = addr[nc];
  165. cbuf[offset + 1] = addr[nc] >> 8;
  166. }
  167. if (id == IPC_CMD_PCNTRL_R) {
  168. for (nc = 0, offset = 0; nc < count; nc++, offset += 4)
  169. ipc_data_writel(wbuf[nc], offset);
  170. ipc_command((count*2) << 16 | id << 12 | 0 << 8 | op);
  171. } else if (id == IPC_CMD_PCNTRL_W) {
  172. for (nc = 0; nc < count; nc++, offset += 1)
  173. cbuf[offset] = data[nc];
  174. for (nc = 0, offset = 0; nc < count; nc++, offset += 4)
  175. ipc_data_writel(wbuf[nc], offset);
  176. ipc_command((count*3) << 16 | id << 12 | 0 << 8 | op);
  177. } else if (id == IPC_CMD_PCNTRL_M) {
  178. cbuf[offset] = data[0];
  179. cbuf[offset + 1] = data[1];
  180. ipc_data_writel(wbuf[0], 0); /* Write wbuff */
  181. ipc_command(4 << 16 | id << 12 | 0 << 8 | op);
  182. }
  183. }
  184. err = busy_loop();
  185. if (id == IPC_CMD_PCNTRL_R) { /* Read rbuf */
  186. /* Workaround: values are read as 0 without memcpy_fromio */
  187. memcpy_fromio(cbuf, ipcdev.ipc_base + 0x90, 16);
  188. if (platform != MRST_CPU_CHIP_PENWELL) {
  189. for (nc = 0, offset = 2; nc < count; nc++, offset += 3)
  190. data[nc] = ipc_data_readb(offset);
  191. } else {
  192. for (nc = 0; nc < count; nc++)
  193. data[nc] = ipc_data_readb(nc);
  194. }
  195. }
  196. mutex_unlock(&ipclock);
  197. return err;
  198. }
  199. /**
  200. * intel_scu_ipc_ioread8 - read a word via the SCU
  201. * @addr: register on SCU
  202. * @data: return pointer for read byte
  203. *
  204. * Read a single register. Returns 0 on success or an error code. All
  205. * locking between SCU accesses is handled for the caller.
  206. *
  207. * This function may sleep.
  208. */
  209. int intel_scu_ipc_ioread8(u16 addr, u8 *data)
  210. {
  211. return pwr_reg_rdwr(&addr, data, 1, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_R);
  212. }
  213. EXPORT_SYMBOL(intel_scu_ipc_ioread8);
  214. /**
  215. * intel_scu_ipc_ioread16 - read a word via the SCU
  216. * @addr: register on SCU
  217. * @data: return pointer for read word
  218. *
  219. * Read a register pair. Returns 0 on success or an error code. All
  220. * locking between SCU accesses is handled for the caller.
  221. *
  222. * This function may sleep.
  223. */
  224. int intel_scu_ipc_ioread16(u16 addr, u16 *data)
  225. {
  226. u16 x[2] = {addr, addr + 1 };
  227. return pwr_reg_rdwr(x, (u8 *)data, 2, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_R);
  228. }
  229. EXPORT_SYMBOL(intel_scu_ipc_ioread16);
  230. /**
  231. * intel_scu_ipc_ioread32 - read a dword via the SCU
  232. * @addr: register on SCU
  233. * @data: return pointer for read dword
  234. *
  235. * Read four registers. 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_ioread32(u16 addr, u32 *data)
  241. {
  242. u16 x[4] = {addr, addr + 1, addr + 2, addr + 3};
  243. return pwr_reg_rdwr(x, (u8 *)data, 4, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_R);
  244. }
  245. EXPORT_SYMBOL(intel_scu_ipc_ioread32);
  246. /**
  247. * intel_scu_ipc_iowrite8 - write a byte via the SCU
  248. * @addr: register on SCU
  249. * @data: byte to write
  250. *
  251. * Write a single register. 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_iowrite8(u16 addr, u8 data)
  257. {
  258. return pwr_reg_rdwr(&addr, &data, 1, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_W);
  259. }
  260. EXPORT_SYMBOL(intel_scu_ipc_iowrite8);
  261. /**
  262. * intel_scu_ipc_iowrite16 - write a word via the SCU
  263. * @addr: register on SCU
  264. * @data: word to write
  265. *
  266. * Write two registers. Returns 0 on success or an error code. All
  267. * locking between SCU accesses is handled for the caller.
  268. *
  269. * This function may sleep.
  270. */
  271. int intel_scu_ipc_iowrite16(u16 addr, u16 data)
  272. {
  273. u16 x[2] = {addr, addr + 1 };
  274. return pwr_reg_rdwr(x, (u8 *)&data, 2, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_W);
  275. }
  276. EXPORT_SYMBOL(intel_scu_ipc_iowrite16);
  277. /**
  278. * intel_scu_ipc_iowrite32 - write a dword via the SCU
  279. * @addr: register on SCU
  280. * @data: dword to write
  281. *
  282. * Write four registers. Returns 0 on success or an error code. All
  283. * locking between SCU accesses is handled for the caller.
  284. *
  285. * This function may sleep.
  286. */
  287. int intel_scu_ipc_iowrite32(u16 addr, u32 data)
  288. {
  289. u16 x[4] = {addr, addr + 1, addr + 2, addr + 3};
  290. return pwr_reg_rdwr(x, (u8 *)&data, 4, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_W);
  291. }
  292. EXPORT_SYMBOL(intel_scu_ipc_iowrite32);
  293. /**
  294. * intel_scu_ipc_readvv - read a set of registers
  295. * @addr: register list
  296. * @data: bytes to return
  297. * @len: length of array
  298. *
  299. * Read registers. Returns 0 on success or an error code. All
  300. * locking between SCU accesses is handled for the caller.
  301. *
  302. * The largest array length permitted by the hardware is 5 items.
  303. *
  304. * This function may sleep.
  305. */
  306. int intel_scu_ipc_readv(u16 *addr, u8 *data, int len)
  307. {
  308. return pwr_reg_rdwr(addr, data, len, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_R);
  309. }
  310. EXPORT_SYMBOL(intel_scu_ipc_readv);
  311. /**
  312. * intel_scu_ipc_writev - write a set of registers
  313. * @addr: register list
  314. * @data: bytes to write
  315. * @len: length of array
  316. *
  317. * Write registers. Returns 0 on success or an error code. All
  318. * locking between SCU accesses is handled for the caller.
  319. *
  320. * The largest array length permitted by the hardware is 5 items.
  321. *
  322. * This function may sleep.
  323. *
  324. */
  325. int intel_scu_ipc_writev(u16 *addr, u8 *data, int len)
  326. {
  327. return pwr_reg_rdwr(addr, data, len, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_W);
  328. }
  329. EXPORT_SYMBOL(intel_scu_ipc_writev);
  330. /**
  331. * intel_scu_ipc_update_register - r/m/w a register
  332. * @addr: register address
  333. * @bits: bits to update
  334. * @mask: mask of bits to update
  335. *
  336. * Read-modify-write power control unit register. The first data argument
  337. * must be register value and second is mask value
  338. * mask is a bitmap that indicates which bits to update.
  339. * 0 = masked. Don't modify this bit, 1 = modify this bit.
  340. * returns 0 on success or an error code.
  341. *
  342. * This function may sleep. Locking between SCU accesses is handled
  343. * for the caller.
  344. */
  345. int intel_scu_ipc_update_register(u16 addr, u8 bits, u8 mask)
  346. {
  347. u8 data[2] = { bits, mask };
  348. return pwr_reg_rdwr(&addr, data, 1, IPCMSG_PCNTRL, IPC_CMD_PCNTRL_M);
  349. }
  350. EXPORT_SYMBOL(intel_scu_ipc_update_register);
  351. /**
  352. * intel_scu_ipc_simple_command - send a simple command
  353. * @cmd: command
  354. * @sub: sub type
  355. *
  356. * Issue a simple command to the SCU. Do not use this interface if
  357. * you must then access data as any data values may be overwritten
  358. * by another SCU access by the time this function returns.
  359. *
  360. * This function may sleep. Locking for SCU accesses is handled for
  361. * the caller.
  362. */
  363. int intel_scu_ipc_simple_command(int cmd, int sub)
  364. {
  365. u32 err = 0;
  366. mutex_lock(&ipclock);
  367. if (ipcdev.pdev == NULL) {
  368. mutex_unlock(&ipclock);
  369. return -ENODEV;
  370. }
  371. ipc_command(sub << 12 | cmd);
  372. err = busy_loop();
  373. mutex_unlock(&ipclock);
  374. return err;
  375. }
  376. EXPORT_SYMBOL(intel_scu_ipc_simple_command);
  377. /**
  378. * intel_scu_ipc_command - command with data
  379. * @cmd: command
  380. * @sub: sub type
  381. * @in: input data
  382. * @inlen: input length in dwords
  383. * @out: output data
  384. * @outlein: output length in dwords
  385. *
  386. * Issue a command to the SCU which involves data transfers. Do the
  387. * data copies under the lock but leave it for the caller to interpret
  388. */
  389. int intel_scu_ipc_command(int cmd, int sub, u32 *in, int inlen,
  390. u32 *out, int outlen)
  391. {
  392. u32 err = 0;
  393. int i = 0;
  394. mutex_lock(&ipclock);
  395. if (ipcdev.pdev == NULL) {
  396. mutex_unlock(&ipclock);
  397. return -ENODEV;
  398. }
  399. for (i = 0; i < inlen; i++)
  400. ipc_data_writel(*in++, 4 * i);
  401. ipc_command((sub << 12) | cmd | (inlen << 18));
  402. err = busy_loop();
  403. for (i = 0; i < outlen; i++)
  404. *out++ = ipc_data_readl(4 * i);
  405. mutex_unlock(&ipclock);
  406. return err;
  407. }
  408. EXPORT_SYMBOL(intel_scu_ipc_command);
  409. /*I2C commands */
  410. #define IPC_I2C_WRITE 1 /* I2C Write command */
  411. #define IPC_I2C_READ 2 /* I2C Read command */
  412. /**
  413. * intel_scu_ipc_i2c_cntrl - I2C read/write operations
  414. * @addr: I2C address + command bits
  415. * @data: data to read/write
  416. *
  417. * Perform an an I2C read/write operation via the SCU. All locking is
  418. * handled for the caller. This function may sleep.
  419. *
  420. * Returns an error code or 0 on success.
  421. *
  422. * This has to be in the IPC driver for the locking.
  423. */
  424. int intel_scu_ipc_i2c_cntrl(u32 addr, u32 *data)
  425. {
  426. u32 cmd = 0;
  427. mutex_lock(&ipclock);
  428. if (ipcdev.pdev == NULL) {
  429. mutex_unlock(&ipclock);
  430. return -ENODEV;
  431. }
  432. cmd = (addr >> 24) & 0xFF;
  433. if (cmd == IPC_I2C_READ) {
  434. writel(addr, ipcdev.i2c_base + IPC_I2C_CNTRL_ADDR);
  435. /* Write not getting updated without delay */
  436. mdelay(1);
  437. *data = readl(ipcdev.i2c_base + I2C_DATA_ADDR);
  438. } else if (cmd == IPC_I2C_WRITE) {
  439. writel(addr, ipcdev.i2c_base + I2C_DATA_ADDR);
  440. mdelay(1);
  441. writel(addr, ipcdev.i2c_base + IPC_I2C_CNTRL_ADDR);
  442. } else {
  443. dev_err(&ipcdev.pdev->dev,
  444. "intel_scu_ipc: I2C INVALID_CMD = 0x%x\n", cmd);
  445. mutex_unlock(&ipclock);
  446. return -1;
  447. }
  448. mutex_unlock(&ipclock);
  449. return 0;
  450. }
  451. EXPORT_SYMBOL(intel_scu_ipc_i2c_cntrl);
  452. #define IPC_FW_LOAD_ADDR 0xFFFC0000 /* Storage location for FW image */
  453. #define IPC_FW_UPDATE_MBOX_ADDR 0xFFFFDFF4 /* Mailbox between ipc and scu */
  454. #define IPC_MAX_FW_SIZE 262144 /* 256K storage size for loading the FW image */
  455. #define IPC_FW_MIP_HEADER_SIZE 2048 /* Firmware MIP header size */
  456. /* IPC inform SCU to get ready for update process */
  457. #define IPC_CMD_FW_UPDATE_READY 0x10FE
  458. /* IPC inform SCU to go for update process */
  459. #define IPC_CMD_FW_UPDATE_GO 0x20FE
  460. /* Status code for fw update */
  461. #define IPC_FW_UPDATE_SUCCESS 0x444f4e45 /* Status code 'DONE' */
  462. #define IPC_FW_UPDATE_BADN 0x4241444E /* Status code 'BADN' */
  463. #define IPC_FW_TXHIGH 0x54784849 /* Status code 'IPC_FW_TXHIGH' */
  464. #define IPC_FW_TXLOW 0x54784c4f /* Status code 'IPC_FW_TXLOW' */
  465. struct fw_update_mailbox {
  466. u32 status;
  467. u32 scu_flag;
  468. u32 driver_flag;
  469. };
  470. /**
  471. * intel_scu_ipc_fw_update - Firmware update utility
  472. * @buffer: firmware buffer
  473. * @length: size of firmware buffer
  474. *
  475. * This function provides an interface to load the firmware into
  476. * the SCU. Returns 0 on success or -1 on failure
  477. */
  478. int intel_scu_ipc_fw_update(u8 *buffer, u32 length)
  479. {
  480. void __iomem *fw_update_base;
  481. struct fw_update_mailbox __iomem *mailbox = NULL;
  482. int retry_cnt = 0;
  483. u32 status;
  484. mutex_lock(&ipclock);
  485. fw_update_base = ioremap_nocache(IPC_FW_LOAD_ADDR, (128*1024));
  486. if (fw_update_base == NULL) {
  487. mutex_unlock(&ipclock);
  488. return -ENOMEM;
  489. }
  490. mailbox = ioremap_nocache(IPC_FW_UPDATE_MBOX_ADDR,
  491. sizeof(struct fw_update_mailbox));
  492. if (mailbox == NULL) {
  493. iounmap(fw_update_base);
  494. mutex_unlock(&ipclock);
  495. return -ENOMEM;
  496. }
  497. ipc_command(IPC_CMD_FW_UPDATE_READY);
  498. /* Intitialize mailbox */
  499. writel(0, &mailbox->status);
  500. writel(0, &mailbox->scu_flag);
  501. writel(0, &mailbox->driver_flag);
  502. /* Driver copies the 2KB MIP header to SRAM at 0xFFFC0000*/
  503. memcpy_toio(fw_update_base, buffer, 0x800);
  504. /* Driver sends "FW Update" IPC command (CMD_ID 0xFE; MSG_ID 0x02).
  505. * Upon receiving this command, SCU will write the 2K MIP header
  506. * from 0xFFFC0000 into NAND.
  507. * SCU will write a status code into the Mailbox, and then set scu_flag.
  508. */
  509. ipc_command(IPC_CMD_FW_UPDATE_GO);
  510. /*Driver stalls until scu_flag is set */
  511. while (readl(&mailbox->scu_flag) != 1) {
  512. rmb();
  513. mdelay(1);
  514. }
  515. /* Driver checks Mailbox status.
  516. * If the status is 'BADN', then abort (bad NAND).
  517. * If the status is 'IPC_FW_TXLOW', then continue.
  518. */
  519. while (readl(&mailbox->status) != IPC_FW_TXLOW) {
  520. rmb();
  521. mdelay(10);
  522. }
  523. mdelay(10);
  524. update_retry:
  525. if (retry_cnt > 5)
  526. goto update_end;
  527. if (readl(&mailbox->status) != IPC_FW_TXLOW)
  528. goto update_end;
  529. buffer = buffer + 0x800;
  530. memcpy_toio(fw_update_base, buffer, 0x20000);
  531. writel(1, &mailbox->driver_flag);
  532. while (readl(&mailbox->scu_flag) == 1) {
  533. rmb();
  534. mdelay(1);
  535. }
  536. /* check for 'BADN' */
  537. if (readl(&mailbox->status) == IPC_FW_UPDATE_BADN)
  538. goto update_end;
  539. while (readl(&mailbox->status) != IPC_FW_TXHIGH) {
  540. rmb();
  541. mdelay(10);
  542. }
  543. mdelay(10);
  544. if (readl(&mailbox->status) != IPC_FW_TXHIGH)
  545. goto update_end;
  546. buffer = buffer + 0x20000;
  547. memcpy_toio(fw_update_base, buffer, 0x20000);
  548. writel(0, &mailbox->driver_flag);
  549. while (mailbox->scu_flag == 0) {
  550. rmb();
  551. mdelay(1);
  552. }
  553. /* check for 'BADN' */
  554. if (readl(&mailbox->status) == IPC_FW_UPDATE_BADN)
  555. goto update_end;
  556. if (readl(&mailbox->status) == IPC_FW_TXLOW) {
  557. ++retry_cnt;
  558. goto update_retry;
  559. }
  560. update_end:
  561. status = readl(&mailbox->status);
  562. iounmap(fw_update_base);
  563. iounmap(mailbox);
  564. mutex_unlock(&ipclock);
  565. if (status == IPC_FW_UPDATE_SUCCESS)
  566. return 0;
  567. return -1;
  568. }
  569. EXPORT_SYMBOL(intel_scu_ipc_fw_update);
  570. /*
  571. * Interrupt handler gets called when ioc bit of IPC_COMMAND_REG set to 1
  572. * When ioc bit is set to 1, caller api must wait for interrupt handler called
  573. * which in turn unlocks the caller api. Currently this is not used
  574. *
  575. * This is edge triggered so we need take no action to clear anything
  576. */
  577. static irqreturn_t ioc(int irq, void *dev_id)
  578. {
  579. return IRQ_HANDLED;
  580. }
  581. /**
  582. * ipc_probe - probe an Intel SCU IPC
  583. * @dev: the PCI device matching
  584. * @id: entry in the match table
  585. *
  586. * Enable and install an intel SCU IPC. This appears in the PCI space
  587. * but uses some hard coded addresses as well.
  588. */
  589. static int ipc_probe(struct pci_dev *dev, const struct pci_device_id *id)
  590. {
  591. int err;
  592. resource_size_t pci_resource;
  593. if (ipcdev.pdev) /* We support only one SCU */
  594. return -EBUSY;
  595. ipcdev.pdev = pci_dev_get(dev);
  596. err = pci_enable_device(dev);
  597. if (err)
  598. return err;
  599. err = pci_request_regions(dev, "intel_scu_ipc");
  600. if (err)
  601. return err;
  602. pci_resource = pci_resource_start(dev, 0);
  603. if (!pci_resource)
  604. return -ENOMEM;
  605. if (request_irq(dev->irq, ioc, 0, "intel_scu_ipc", &ipcdev))
  606. return -EBUSY;
  607. ipcdev.ipc_base = ioremap_nocache(IPC_BASE_ADDR, IPC_MAX_ADDR);
  608. if (!ipcdev.ipc_base)
  609. return -ENOMEM;
  610. ipcdev.i2c_base = ioremap_nocache(IPC_I2C_BASE, IPC_I2C_MAX_ADDR);
  611. if (!ipcdev.i2c_base) {
  612. iounmap(ipcdev.ipc_base);
  613. return -ENOMEM;
  614. }
  615. return 0;
  616. }
  617. /**
  618. * ipc_remove - remove a bound IPC device
  619. * @pdev: PCI device
  620. *
  621. * In practice the SCU is not removable but this function is also
  622. * called for each device on a module unload or cleanup which is the
  623. * path that will get used.
  624. *
  625. * Free up the mappings and release the PCI resources
  626. */
  627. static void ipc_remove(struct pci_dev *pdev)
  628. {
  629. free_irq(pdev->irq, &ipcdev);
  630. pci_release_regions(pdev);
  631. pci_dev_put(ipcdev.pdev);
  632. iounmap(ipcdev.ipc_base);
  633. iounmap(ipcdev.i2c_base);
  634. ipcdev.pdev = NULL;
  635. }
  636. static const struct pci_device_id pci_ids[] = {
  637. {PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x080e)},
  638. {PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x082a)},
  639. { 0,}
  640. };
  641. MODULE_DEVICE_TABLE(pci, pci_ids);
  642. static struct pci_driver ipc_driver = {
  643. .name = "intel_scu_ipc",
  644. .id_table = pci_ids,
  645. .probe = ipc_probe,
  646. .remove = ipc_remove,
  647. };
  648. static int __init intel_scu_ipc_init(void)
  649. {
  650. platform = mrst_identify_cpu();
  651. if (platform == 0)
  652. return -ENODEV;
  653. return pci_register_driver(&ipc_driver);
  654. }
  655. static void __exit intel_scu_ipc_exit(void)
  656. {
  657. pci_unregister_driver(&ipc_driver);
  658. }
  659. MODULE_AUTHOR("Sreedhara DS <sreedhara.ds@intel.com>");
  660. MODULE_DESCRIPTION("Intel SCU IPC driver");
  661. MODULE_LICENSE("GPL");
  662. module_init(intel_scu_ipc_init);
  663. module_exit(intel_scu_ipc_exit);