intel-m10-bmc-sec-update.c 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774
  1. // SPDX-License-Identifier: GPL-2.0
  2. /*
  3. * Intel MAX10 Board Management Controller Secure Update Driver
  4. *
  5. * Copyright (C) 2019-2022 Intel Corporation. All rights reserved.
  6. *
  7. */
  8. #include <linux/bitfield.h>
  9. #include <linux/device.h>
  10. #include <linux/firmware.h>
  11. #include <linux/mfd/intel-m10-bmc.h>
  12. #include <linux/mod_devicetable.h>
  13. #include <linux/module.h>
  14. #include <linux/platform_device.h>
  15. #include <linux/slab.h>
  16. struct m10bmc_sec;
  17. struct m10bmc_sec_ops {
  18. int (*rsu_status)(struct m10bmc_sec *sec);
  19. };
  20. struct m10bmc_sec {
  21. struct device *dev;
  22. struct intel_m10bmc *m10bmc;
  23. struct fw_upload *fwl;
  24. char *fw_name;
  25. u32 fw_name_id;
  26. bool cancel_request;
  27. const struct m10bmc_sec_ops *ops;
  28. };
  29. static DEFINE_XARRAY_ALLOC(fw_upload_xa);
  30. /* Root Entry Hash (REH) support */
  31. #define REH_SHA256_SIZE 32
  32. #define REH_SHA384_SIZE 48
  33. #define REH_MAGIC GENMASK(15, 0)
  34. #define REH_SHA_NUM_BYTES GENMASK(31, 16)
  35. static int m10bmc_sec_write(struct m10bmc_sec *sec, const u8 *buf, u32 offset, u32 size)
  36. {
  37. struct intel_m10bmc *m10bmc = sec->m10bmc;
  38. unsigned int stride = regmap_get_reg_stride(m10bmc->regmap);
  39. u32 write_count = size / stride;
  40. u32 leftover_offset = write_count * stride;
  41. u32 leftover_size = size - leftover_offset;
  42. u32 leftover_tmp = 0;
  43. int ret;
  44. if (sec->m10bmc->flash_bulk_ops)
  45. return sec->m10bmc->flash_bulk_ops->write(m10bmc, buf, offset, size);
  46. if (WARN_ON_ONCE(stride > sizeof(leftover_tmp)))
  47. return -EINVAL;
  48. ret = regmap_bulk_write(m10bmc->regmap, M10BMC_STAGING_BASE + offset,
  49. buf + offset, write_count);
  50. if (ret)
  51. return ret;
  52. /* If size is not aligned to stride, handle the remainder bytes with regmap_write() */
  53. if (leftover_size) {
  54. memcpy(&leftover_tmp, buf + leftover_offset, leftover_size);
  55. ret = regmap_write(m10bmc->regmap, M10BMC_STAGING_BASE + offset + leftover_offset,
  56. leftover_tmp);
  57. if (ret)
  58. return ret;
  59. }
  60. return 0;
  61. }
  62. static int m10bmc_sec_read(struct m10bmc_sec *sec, u8 *buf, u32 addr, u32 size)
  63. {
  64. struct intel_m10bmc *m10bmc = sec->m10bmc;
  65. unsigned int stride = regmap_get_reg_stride(m10bmc->regmap);
  66. u32 read_count = size / stride;
  67. u32 leftover_offset = read_count * stride;
  68. u32 leftover_size = size - leftover_offset;
  69. u32 leftover_tmp;
  70. int ret;
  71. if (sec->m10bmc->flash_bulk_ops)
  72. return sec->m10bmc->flash_bulk_ops->read(m10bmc, buf, addr, size);
  73. if (WARN_ON_ONCE(stride > sizeof(leftover_tmp)))
  74. return -EINVAL;
  75. ret = regmap_bulk_read(m10bmc->regmap, addr, buf, read_count);
  76. if (ret)
  77. return ret;
  78. /* If size is not aligned to stride, handle the remainder bytes with regmap_read() */
  79. if (leftover_size) {
  80. ret = regmap_read(m10bmc->regmap, addr + leftover_offset, &leftover_tmp);
  81. if (ret)
  82. return ret;
  83. memcpy(buf + leftover_offset, &leftover_tmp, leftover_size);
  84. }
  85. return 0;
  86. }
  87. static ssize_t
  88. show_root_entry_hash(struct device *dev, u32 exp_magic,
  89. u32 prog_addr, u32 reh_addr, char *buf)
  90. {
  91. struct m10bmc_sec *sec = dev_get_drvdata(dev);
  92. int sha_num_bytes, i, ret, cnt = 0;
  93. u8 hash[REH_SHA384_SIZE];
  94. u32 magic;
  95. ret = m10bmc_sec_read(sec, (u8 *)&magic, prog_addr, sizeof(magic));
  96. if (ret)
  97. return ret;
  98. if (FIELD_GET(REH_MAGIC, magic) != exp_magic)
  99. return sysfs_emit(buf, "hash not programmed\n");
  100. sha_num_bytes = FIELD_GET(REH_SHA_NUM_BYTES, magic) / 8;
  101. if (sha_num_bytes != REH_SHA256_SIZE &&
  102. sha_num_bytes != REH_SHA384_SIZE) {
  103. dev_err(sec->dev, "%s bad sha num bytes %d\n", __func__,
  104. sha_num_bytes);
  105. return -EINVAL;
  106. }
  107. ret = m10bmc_sec_read(sec, hash, reh_addr, sha_num_bytes);
  108. if (ret) {
  109. dev_err(dev, "failed to read root entry hash\n");
  110. return ret;
  111. }
  112. for (i = 0; i < sha_num_bytes; i++)
  113. cnt += sprintf(buf + cnt, "%02x", hash[i]);
  114. cnt += sprintf(buf + cnt, "\n");
  115. return cnt;
  116. }
  117. #define DEVICE_ATTR_SEC_REH_RO(_name) \
  118. static ssize_t _name##_root_entry_hash_show(struct device *dev, \
  119. struct device_attribute *attr, \
  120. char *buf) \
  121. { \
  122. struct m10bmc_sec *sec = dev_get_drvdata(dev); \
  123. const struct m10bmc_csr_map *csr_map = sec->m10bmc->info->csr_map; \
  124. \
  125. return show_root_entry_hash(dev, csr_map->_name##_magic, \
  126. csr_map->_name##_prog_addr, \
  127. csr_map->_name##_reh_addr, \
  128. buf); \
  129. } \
  130. static DEVICE_ATTR_RO(_name##_root_entry_hash)
  131. DEVICE_ATTR_SEC_REH_RO(bmc);
  132. DEVICE_ATTR_SEC_REH_RO(sr);
  133. DEVICE_ATTR_SEC_REH_RO(pr);
  134. #define CSK_BIT_LEN 128U
  135. #define CSK_32ARRAY_SIZE DIV_ROUND_UP(CSK_BIT_LEN, 32)
  136. static ssize_t
  137. show_canceled_csk(struct device *dev, u32 addr, char *buf)
  138. {
  139. unsigned int i, size = CSK_32ARRAY_SIZE * sizeof(u32);
  140. struct m10bmc_sec *sec = dev_get_drvdata(dev);
  141. DECLARE_BITMAP(csk_map, CSK_BIT_LEN);
  142. __le32 csk_le32[CSK_32ARRAY_SIZE];
  143. u32 csk32[CSK_32ARRAY_SIZE];
  144. int ret;
  145. ret = m10bmc_sec_read(sec, (u8 *)&csk_le32, addr, size);
  146. if (ret) {
  147. dev_err(sec->dev, "failed to read CSK vector\n");
  148. return ret;
  149. }
  150. for (i = 0; i < CSK_32ARRAY_SIZE; i++)
  151. csk32[i] = le32_to_cpu(((csk_le32[i])));
  152. bitmap_from_arr32(csk_map, csk32, CSK_BIT_LEN);
  153. bitmap_complement(csk_map, csk_map, CSK_BIT_LEN);
  154. return bitmap_print_to_pagebuf(1, buf, csk_map, CSK_BIT_LEN);
  155. }
  156. #define DEVICE_ATTR_SEC_CSK_RO(_name) \
  157. static ssize_t _name##_canceled_csks_show(struct device *dev, \
  158. struct device_attribute *attr, \
  159. char *buf) \
  160. { \
  161. struct m10bmc_sec *sec = dev_get_drvdata(dev); \
  162. const struct m10bmc_csr_map *csr_map = sec->m10bmc->info->csr_map; \
  163. \
  164. return show_canceled_csk(dev, \
  165. csr_map->_name##_prog_addr + CSK_VEC_OFFSET, \
  166. buf); \
  167. } \
  168. static DEVICE_ATTR_RO(_name##_canceled_csks)
  169. #define CSK_VEC_OFFSET 0x34
  170. DEVICE_ATTR_SEC_CSK_RO(bmc);
  171. DEVICE_ATTR_SEC_CSK_RO(sr);
  172. DEVICE_ATTR_SEC_CSK_RO(pr);
  173. #define FLASH_COUNT_SIZE 4096 /* count stored as inverted bit vector */
  174. static ssize_t flash_count_show(struct device *dev,
  175. struct device_attribute *attr, char *buf)
  176. {
  177. struct m10bmc_sec *sec = dev_get_drvdata(dev);
  178. const struct m10bmc_csr_map *csr_map = sec->m10bmc->info->csr_map;
  179. unsigned int num_bits;
  180. u8 *flash_buf;
  181. int cnt, ret;
  182. num_bits = FLASH_COUNT_SIZE * 8;
  183. flash_buf = kmalloc(FLASH_COUNT_SIZE, GFP_KERNEL);
  184. if (!flash_buf)
  185. return -ENOMEM;
  186. ret = m10bmc_sec_read(sec, flash_buf, csr_map->rsu_update_counter,
  187. FLASH_COUNT_SIZE);
  188. if (ret) {
  189. dev_err(sec->dev, "failed to read flash count\n");
  190. goto exit_free;
  191. }
  192. cnt = num_bits - bitmap_weight((unsigned long *)flash_buf, num_bits);
  193. exit_free:
  194. kfree(flash_buf);
  195. return ret ? : sysfs_emit(buf, "%u\n", cnt);
  196. }
  197. static DEVICE_ATTR_RO(flash_count);
  198. static struct attribute *m10bmc_security_attrs[] = {
  199. &dev_attr_flash_count.attr,
  200. &dev_attr_bmc_root_entry_hash.attr,
  201. &dev_attr_sr_root_entry_hash.attr,
  202. &dev_attr_pr_root_entry_hash.attr,
  203. &dev_attr_sr_canceled_csks.attr,
  204. &dev_attr_pr_canceled_csks.attr,
  205. &dev_attr_bmc_canceled_csks.attr,
  206. NULL,
  207. };
  208. static struct attribute_group m10bmc_security_attr_group = {
  209. .name = "security",
  210. .attrs = m10bmc_security_attrs,
  211. };
  212. static const struct attribute_group *m10bmc_sec_attr_groups[] = {
  213. &m10bmc_security_attr_group,
  214. NULL,
  215. };
  216. static void log_error_regs(struct m10bmc_sec *sec, u32 doorbell)
  217. {
  218. const struct m10bmc_csr_map *csr_map = sec->m10bmc->info->csr_map;
  219. u32 auth_result;
  220. dev_err(sec->dev, "Doorbell: 0x%08x\n", doorbell);
  221. if (!m10bmc_sys_read(sec->m10bmc, csr_map->auth_result, &auth_result))
  222. dev_err(sec->dev, "RSU auth result: 0x%08x\n", auth_result);
  223. }
  224. static int m10bmc_sec_n3000_rsu_status(struct m10bmc_sec *sec)
  225. {
  226. const struct m10bmc_csr_map *csr_map = sec->m10bmc->info->csr_map;
  227. u32 doorbell;
  228. int ret;
  229. ret = m10bmc_sys_read(sec->m10bmc, csr_map->doorbell, &doorbell);
  230. if (ret)
  231. return ret;
  232. return FIELD_GET(DRBL_RSU_STATUS, doorbell);
  233. }
  234. static int m10bmc_sec_n6000_rsu_status(struct m10bmc_sec *sec)
  235. {
  236. const struct m10bmc_csr_map *csr_map = sec->m10bmc->info->csr_map;
  237. u32 auth_result;
  238. int ret;
  239. ret = m10bmc_sys_read(sec->m10bmc, csr_map->auth_result, &auth_result);
  240. if (ret)
  241. return ret;
  242. return FIELD_GET(AUTH_RESULT_RSU_STATUS, auth_result);
  243. }
  244. static bool rsu_status_ok(u32 status)
  245. {
  246. return (status == RSU_STAT_NORMAL ||
  247. status == RSU_STAT_NIOS_OK ||
  248. status == RSU_STAT_USER_OK ||
  249. status == RSU_STAT_FACTORY_OK);
  250. }
  251. static bool rsu_progress_done(u32 progress)
  252. {
  253. return (progress == RSU_PROG_IDLE ||
  254. progress == RSU_PROG_RSU_DONE);
  255. }
  256. static bool rsu_progress_busy(u32 progress)
  257. {
  258. return (progress == RSU_PROG_AUTHENTICATING ||
  259. progress == RSU_PROG_COPYING ||
  260. progress == RSU_PROG_UPDATE_CANCEL ||
  261. progress == RSU_PROG_PROGRAM_KEY_HASH);
  262. }
  263. static int m10bmc_sec_progress_status(struct m10bmc_sec *sec, u32 *doorbell_reg,
  264. u32 *progress, u32 *status)
  265. {
  266. const struct m10bmc_csr_map *csr_map = sec->m10bmc->info->csr_map;
  267. int ret;
  268. ret = m10bmc_sys_read(sec->m10bmc, csr_map->doorbell, doorbell_reg);
  269. if (ret)
  270. return ret;
  271. ret = sec->ops->rsu_status(sec);
  272. if (ret < 0)
  273. return ret;
  274. *status = ret;
  275. *progress = rsu_prog(*doorbell_reg);
  276. return 0;
  277. }
  278. static enum fw_upload_err rsu_check_idle(struct m10bmc_sec *sec)
  279. {
  280. const struct m10bmc_csr_map *csr_map = sec->m10bmc->info->csr_map;
  281. u32 doorbell;
  282. int ret;
  283. ret = m10bmc_sys_read(sec->m10bmc, csr_map->doorbell, &doorbell);
  284. if (ret)
  285. return FW_UPLOAD_ERR_RW_ERROR;
  286. if (!rsu_progress_done(rsu_prog(doorbell))) {
  287. log_error_regs(sec, doorbell);
  288. return FW_UPLOAD_ERR_BUSY;
  289. }
  290. return FW_UPLOAD_ERR_NONE;
  291. }
  292. static inline bool rsu_start_done(u32 doorbell_reg, u32 progress, u32 status)
  293. {
  294. if (doorbell_reg & DRBL_RSU_REQUEST)
  295. return false;
  296. if (status == RSU_STAT_ERASE_FAIL || status == RSU_STAT_WEAROUT)
  297. return true;
  298. if (!rsu_progress_done(progress))
  299. return true;
  300. return false;
  301. }
  302. static enum fw_upload_err rsu_update_init(struct m10bmc_sec *sec)
  303. {
  304. const struct m10bmc_csr_map *csr_map = sec->m10bmc->info->csr_map;
  305. u32 doorbell_reg, progress, status;
  306. int ret, err;
  307. ret = m10bmc_sys_update_bits(sec->m10bmc, csr_map->doorbell,
  308. DRBL_RSU_REQUEST | DRBL_HOST_STATUS,
  309. DRBL_RSU_REQUEST |
  310. FIELD_PREP(DRBL_HOST_STATUS,
  311. HOST_STATUS_IDLE));
  312. if (ret)
  313. return FW_UPLOAD_ERR_RW_ERROR;
  314. ret = read_poll_timeout(m10bmc_sec_progress_status, err,
  315. err < 0 || rsu_start_done(doorbell_reg, progress, status),
  316. NIOS_HANDSHAKE_INTERVAL_US,
  317. NIOS_HANDSHAKE_TIMEOUT_US,
  318. false,
  319. sec, &doorbell_reg, &progress, &status);
  320. if (ret == -ETIMEDOUT) {
  321. log_error_regs(sec, doorbell_reg);
  322. return FW_UPLOAD_ERR_TIMEOUT;
  323. } else if (err) {
  324. return FW_UPLOAD_ERR_RW_ERROR;
  325. }
  326. if (status == RSU_STAT_WEAROUT) {
  327. dev_warn(sec->dev, "Excessive flash update count detected\n");
  328. return FW_UPLOAD_ERR_WEAROUT;
  329. } else if (status == RSU_STAT_ERASE_FAIL) {
  330. log_error_regs(sec, doorbell_reg);
  331. return FW_UPLOAD_ERR_HW_ERROR;
  332. }
  333. return FW_UPLOAD_ERR_NONE;
  334. }
  335. static enum fw_upload_err rsu_prog_ready(struct m10bmc_sec *sec)
  336. {
  337. const struct m10bmc_csr_map *csr_map = sec->m10bmc->info->csr_map;
  338. unsigned long poll_timeout;
  339. u32 doorbell, progress;
  340. int ret;
  341. ret = m10bmc_sys_read(sec->m10bmc, csr_map->doorbell, &doorbell);
  342. if (ret)
  343. return FW_UPLOAD_ERR_RW_ERROR;
  344. poll_timeout = jiffies + msecs_to_jiffies(RSU_PREP_TIMEOUT_MS);
  345. while (rsu_prog(doorbell) == RSU_PROG_PREPARE) {
  346. msleep(RSU_PREP_INTERVAL_MS);
  347. if (time_after(jiffies, poll_timeout))
  348. break;
  349. ret = m10bmc_sys_read(sec->m10bmc, csr_map->doorbell, &doorbell);
  350. if (ret)
  351. return FW_UPLOAD_ERR_RW_ERROR;
  352. }
  353. progress = rsu_prog(doorbell);
  354. if (progress == RSU_PROG_PREPARE) {
  355. log_error_regs(sec, doorbell);
  356. return FW_UPLOAD_ERR_TIMEOUT;
  357. } else if (progress != RSU_PROG_READY) {
  358. log_error_regs(sec, doorbell);
  359. return FW_UPLOAD_ERR_HW_ERROR;
  360. }
  361. return FW_UPLOAD_ERR_NONE;
  362. }
  363. static enum fw_upload_err rsu_send_data(struct m10bmc_sec *sec)
  364. {
  365. const struct m10bmc_csr_map *csr_map = sec->m10bmc->info->csr_map;
  366. u32 doorbell_reg, status;
  367. int ret;
  368. ret = m10bmc_sys_update_bits(sec->m10bmc, csr_map->doorbell,
  369. DRBL_HOST_STATUS,
  370. FIELD_PREP(DRBL_HOST_STATUS,
  371. HOST_STATUS_WRITE_DONE));
  372. if (ret)
  373. return FW_UPLOAD_ERR_RW_ERROR;
  374. ret = regmap_read_poll_timeout(sec->m10bmc->regmap,
  375. csr_map->base + csr_map->doorbell,
  376. doorbell_reg,
  377. rsu_prog(doorbell_reg) != RSU_PROG_READY,
  378. NIOS_HANDSHAKE_INTERVAL_US,
  379. NIOS_HANDSHAKE_TIMEOUT_US);
  380. if (ret == -ETIMEDOUT) {
  381. log_error_regs(sec, doorbell_reg);
  382. return FW_UPLOAD_ERR_TIMEOUT;
  383. } else if (ret) {
  384. return FW_UPLOAD_ERR_RW_ERROR;
  385. }
  386. ret = sec->ops->rsu_status(sec);
  387. if (ret < 0)
  388. return FW_UPLOAD_ERR_HW_ERROR;
  389. status = ret;
  390. if (!rsu_status_ok(status)) {
  391. log_error_regs(sec, doorbell_reg);
  392. return FW_UPLOAD_ERR_HW_ERROR;
  393. }
  394. return FW_UPLOAD_ERR_NONE;
  395. }
  396. static int rsu_check_complete(struct m10bmc_sec *sec, u32 *doorbell_reg)
  397. {
  398. u32 progress, status;
  399. if (m10bmc_sec_progress_status(sec, doorbell_reg, &progress, &status))
  400. return -EIO;
  401. if (!rsu_status_ok(status))
  402. return -EINVAL;
  403. if (rsu_progress_done(progress))
  404. return 0;
  405. if (rsu_progress_busy(progress))
  406. return -EAGAIN;
  407. return -EINVAL;
  408. }
  409. static enum fw_upload_err rsu_cancel(struct m10bmc_sec *sec)
  410. {
  411. const struct m10bmc_csr_map *csr_map = sec->m10bmc->info->csr_map;
  412. u32 doorbell;
  413. int ret;
  414. ret = m10bmc_sys_read(sec->m10bmc, csr_map->doorbell, &doorbell);
  415. if (ret)
  416. return FW_UPLOAD_ERR_RW_ERROR;
  417. if (rsu_prog(doorbell) != RSU_PROG_READY)
  418. return FW_UPLOAD_ERR_BUSY;
  419. ret = m10bmc_sys_update_bits(sec->m10bmc, csr_map->doorbell,
  420. DRBL_HOST_STATUS,
  421. FIELD_PREP(DRBL_HOST_STATUS,
  422. HOST_STATUS_ABORT_RSU));
  423. if (ret)
  424. return FW_UPLOAD_ERR_RW_ERROR;
  425. return FW_UPLOAD_ERR_CANCELED;
  426. }
  427. static enum fw_upload_err m10bmc_sec_prepare(struct fw_upload *fwl,
  428. const u8 *data, u32 size)
  429. {
  430. struct m10bmc_sec *sec = fwl->dd_handle;
  431. const struct m10bmc_csr_map *csr_map = sec->m10bmc->info->csr_map;
  432. u32 ret;
  433. sec->cancel_request = false;
  434. if (!size || size > csr_map->staging_size)
  435. return FW_UPLOAD_ERR_INVALID_SIZE;
  436. if (sec->m10bmc->flash_bulk_ops)
  437. if (sec->m10bmc->flash_bulk_ops->lock_write(sec->m10bmc))
  438. return FW_UPLOAD_ERR_BUSY;
  439. ret = rsu_check_idle(sec);
  440. if (ret != FW_UPLOAD_ERR_NONE)
  441. goto unlock_flash;
  442. m10bmc_fw_state_set(sec->m10bmc, M10BMC_FW_STATE_SEC_UPDATE_PREPARE);
  443. ret = rsu_update_init(sec);
  444. if (ret != FW_UPLOAD_ERR_NONE)
  445. goto fw_state_exit;
  446. ret = rsu_prog_ready(sec);
  447. if (ret != FW_UPLOAD_ERR_NONE)
  448. goto fw_state_exit;
  449. if (sec->cancel_request) {
  450. ret = rsu_cancel(sec);
  451. goto fw_state_exit;
  452. }
  453. m10bmc_fw_state_set(sec->m10bmc, M10BMC_FW_STATE_SEC_UPDATE_WRITE);
  454. return FW_UPLOAD_ERR_NONE;
  455. fw_state_exit:
  456. m10bmc_fw_state_set(sec->m10bmc, M10BMC_FW_STATE_NORMAL);
  457. unlock_flash:
  458. if (sec->m10bmc->flash_bulk_ops)
  459. sec->m10bmc->flash_bulk_ops->unlock_write(sec->m10bmc);
  460. return ret;
  461. }
  462. #define WRITE_BLOCK_SIZE 0x4000 /* Default write-block size is 0x4000 bytes */
  463. static enum fw_upload_err m10bmc_sec_fw_write(struct fw_upload *fwl, const u8 *data,
  464. u32 offset, u32 size, u32 *written)
  465. {
  466. struct m10bmc_sec *sec = fwl->dd_handle;
  467. const struct m10bmc_csr_map *csr_map = sec->m10bmc->info->csr_map;
  468. struct intel_m10bmc *m10bmc = sec->m10bmc;
  469. u32 blk_size, doorbell;
  470. int ret;
  471. if (sec->cancel_request)
  472. return rsu_cancel(sec);
  473. ret = m10bmc_sys_read(m10bmc, csr_map->doorbell, &doorbell);
  474. if (ret) {
  475. return FW_UPLOAD_ERR_RW_ERROR;
  476. } else if (rsu_prog(doorbell) != RSU_PROG_READY) {
  477. log_error_regs(sec, doorbell);
  478. return FW_UPLOAD_ERR_HW_ERROR;
  479. }
  480. WARN_ON_ONCE(WRITE_BLOCK_SIZE % regmap_get_reg_stride(m10bmc->regmap));
  481. blk_size = min_t(u32, WRITE_BLOCK_SIZE, size);
  482. ret = m10bmc_sec_write(sec, data, offset, blk_size);
  483. if (ret)
  484. return FW_UPLOAD_ERR_RW_ERROR;
  485. *written = blk_size;
  486. return FW_UPLOAD_ERR_NONE;
  487. }
  488. static enum fw_upload_err m10bmc_sec_poll_complete(struct fw_upload *fwl)
  489. {
  490. struct m10bmc_sec *sec = fwl->dd_handle;
  491. unsigned long poll_timeout;
  492. u32 doorbell, result;
  493. int ret;
  494. if (sec->cancel_request)
  495. return rsu_cancel(sec);
  496. m10bmc_fw_state_set(sec->m10bmc, M10BMC_FW_STATE_SEC_UPDATE_PROGRAM);
  497. result = rsu_send_data(sec);
  498. if (result != FW_UPLOAD_ERR_NONE)
  499. return result;
  500. poll_timeout = jiffies + msecs_to_jiffies(RSU_COMPLETE_TIMEOUT_MS);
  501. do {
  502. msleep(RSU_COMPLETE_INTERVAL_MS);
  503. ret = rsu_check_complete(sec, &doorbell);
  504. } while (ret == -EAGAIN && !time_after(jiffies, poll_timeout));
  505. if (ret == -EAGAIN) {
  506. log_error_regs(sec, doorbell);
  507. return FW_UPLOAD_ERR_TIMEOUT;
  508. } else if (ret == -EIO) {
  509. return FW_UPLOAD_ERR_RW_ERROR;
  510. } else if (ret) {
  511. log_error_regs(sec, doorbell);
  512. return FW_UPLOAD_ERR_HW_ERROR;
  513. }
  514. return FW_UPLOAD_ERR_NONE;
  515. }
  516. /*
  517. * m10bmc_sec_cancel() may be called asynchronously with an on-going update.
  518. * All other functions are called sequentially in a single thread. To avoid
  519. * contention on register accesses, m10bmc_sec_cancel() must only update
  520. * the cancel_request flag. Other functions will check this flag and handle
  521. * the cancel request synchronously.
  522. */
  523. static void m10bmc_sec_cancel(struct fw_upload *fwl)
  524. {
  525. struct m10bmc_sec *sec = fwl->dd_handle;
  526. sec->cancel_request = true;
  527. }
  528. static void m10bmc_sec_cleanup(struct fw_upload *fwl)
  529. {
  530. struct m10bmc_sec *sec = fwl->dd_handle;
  531. (void)rsu_cancel(sec);
  532. m10bmc_fw_state_set(sec->m10bmc, M10BMC_FW_STATE_NORMAL);
  533. if (sec->m10bmc->flash_bulk_ops)
  534. sec->m10bmc->flash_bulk_ops->unlock_write(sec->m10bmc);
  535. }
  536. static const struct fw_upload_ops m10bmc_ops = {
  537. .prepare = m10bmc_sec_prepare,
  538. .write = m10bmc_sec_fw_write,
  539. .poll_complete = m10bmc_sec_poll_complete,
  540. .cancel = m10bmc_sec_cancel,
  541. .cleanup = m10bmc_sec_cleanup,
  542. };
  543. static const struct m10bmc_sec_ops m10sec_n3000_ops = {
  544. .rsu_status = m10bmc_sec_n3000_rsu_status,
  545. };
  546. static const struct m10bmc_sec_ops m10sec_n6000_ops = {
  547. .rsu_status = m10bmc_sec_n6000_rsu_status,
  548. };
  549. #define SEC_UPDATE_LEN_MAX 32
  550. static int m10bmc_sec_probe(struct platform_device *pdev)
  551. {
  552. char buf[SEC_UPDATE_LEN_MAX];
  553. struct m10bmc_sec *sec;
  554. struct fw_upload *fwl;
  555. unsigned int len;
  556. int ret;
  557. sec = devm_kzalloc(&pdev->dev, sizeof(*sec), GFP_KERNEL);
  558. if (!sec)
  559. return -ENOMEM;
  560. sec->dev = &pdev->dev;
  561. sec->m10bmc = dev_get_drvdata(pdev->dev.parent);
  562. sec->ops = (struct m10bmc_sec_ops *)platform_get_device_id(pdev)->driver_data;
  563. dev_set_drvdata(&pdev->dev, sec);
  564. ret = xa_alloc(&fw_upload_xa, &sec->fw_name_id, sec,
  565. xa_limit_32b, GFP_KERNEL);
  566. if (ret)
  567. return ret;
  568. len = scnprintf(buf, SEC_UPDATE_LEN_MAX, "secure-update%d",
  569. sec->fw_name_id);
  570. sec->fw_name = kmemdup_nul(buf, len, GFP_KERNEL);
  571. if (!sec->fw_name) {
  572. ret = -ENOMEM;
  573. goto fw_name_fail;
  574. }
  575. fwl = firmware_upload_register(THIS_MODULE, sec->dev, sec->fw_name,
  576. &m10bmc_ops, sec);
  577. if (IS_ERR(fwl)) {
  578. dev_err(sec->dev, "Firmware Upload driver failed to start\n");
  579. ret = PTR_ERR(fwl);
  580. goto fw_uploader_fail;
  581. }
  582. sec->fwl = fwl;
  583. return 0;
  584. fw_uploader_fail:
  585. kfree(sec->fw_name);
  586. fw_name_fail:
  587. xa_erase(&fw_upload_xa, sec->fw_name_id);
  588. return ret;
  589. }
  590. static void m10bmc_sec_remove(struct platform_device *pdev)
  591. {
  592. struct m10bmc_sec *sec = dev_get_drvdata(&pdev->dev);
  593. firmware_upload_unregister(sec->fwl);
  594. kfree(sec->fw_name);
  595. xa_erase(&fw_upload_xa, sec->fw_name_id);
  596. }
  597. static const struct platform_device_id intel_m10bmc_sec_ids[] = {
  598. {
  599. .name = "n3000bmc-sec-update",
  600. .driver_data = (kernel_ulong_t)&m10sec_n3000_ops,
  601. },
  602. {
  603. .name = "d5005bmc-sec-update",
  604. .driver_data = (kernel_ulong_t)&m10sec_n3000_ops,
  605. },
  606. {
  607. .name = "n6000bmc-sec-update",
  608. .driver_data = (kernel_ulong_t)&m10sec_n6000_ops,
  609. },
  610. { }
  611. };
  612. MODULE_DEVICE_TABLE(platform, intel_m10bmc_sec_ids);
  613. static struct platform_driver intel_m10bmc_sec_driver = {
  614. .probe = m10bmc_sec_probe,
  615. .remove_new = m10bmc_sec_remove,
  616. .driver = {
  617. .name = "intel-m10bmc-sec-update",
  618. .dev_groups = m10bmc_sec_attr_groups,
  619. },
  620. .id_table = intel_m10bmc_sec_ids,
  621. };
  622. module_platform_driver(intel_m10bmc_sec_driver);
  623. MODULE_AUTHOR("Intel Corporation");
  624. MODULE_DESCRIPTION("Intel MAX10 BMC Secure Update");
  625. MODULE_LICENSE("GPL");
  626. MODULE_IMPORT_NS(INTEL_M10_BMC_CORE);