intel_scu_ipc.c 21 KB

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