dfu.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523
  1. /* SPDX-License-Identifier: GPL-2.0+ */
  2. /*
  3. * dfu.h - DFU flashable area description
  4. *
  5. * Copyright (C) 2012 Samsung Electronics
  6. * authors: Andrzej Pietrasiewicz <andrzej.p@samsung.com>
  7. * Lukasz Majewski <l.majewski@samsung.com>
  8. */
  9. #ifndef __DFU_ENTITY_H_
  10. #define __DFU_ENTITY_H_
  11. #include <common.h>
  12. #include <linux/list.h>
  13. #include <mmc.h>
  14. #include <spi_flash.h>
  15. #include <linux/usb/composite.h>
  16. enum dfu_device_type {
  17. DFU_DEV_MMC = 1,
  18. DFU_DEV_ONENAND,
  19. DFU_DEV_NAND,
  20. DFU_DEV_RAM,
  21. DFU_DEV_SF,
  22. DFU_DEV_MTD,
  23. DFU_DEV_VIRT,
  24. };
  25. enum dfu_layout {
  26. DFU_RAW_ADDR = 1,
  27. DFU_FS_FAT,
  28. DFU_FS_EXT2,
  29. DFU_FS_EXT3,
  30. DFU_FS_EXT4,
  31. DFU_RAM_ADDR,
  32. };
  33. enum dfu_op {
  34. DFU_OP_READ = 1,
  35. DFU_OP_WRITE,
  36. DFU_OP_SIZE,
  37. };
  38. struct mmc_internal_data {
  39. int dev_num;
  40. /* RAW programming */
  41. unsigned int lba_start;
  42. unsigned int lba_size;
  43. unsigned int lba_blk_size;
  44. /* eMMC HW partition access */
  45. int hw_partition;
  46. /* FAT/EXT */
  47. unsigned int dev;
  48. unsigned int part;
  49. };
  50. struct mtd_internal_data {
  51. struct mtd_info *info;
  52. /* RAW programming */
  53. u64 start;
  54. u64 size;
  55. /* for ubi partition */
  56. unsigned int ubi;
  57. };
  58. struct nand_internal_data {
  59. /* RAW programming */
  60. u64 start;
  61. u64 size;
  62. unsigned int dev;
  63. unsigned int part;
  64. /* for nand/ubi use */
  65. unsigned int ubi;
  66. };
  67. struct ram_internal_data {
  68. unsigned long start;
  69. unsigned int size;
  70. };
  71. struct sf_internal_data {
  72. struct spi_flash *dev;
  73. /* RAW programming */
  74. u64 start;
  75. u64 size;
  76. /* for sf/ubi use */
  77. unsigned int ubi;
  78. };
  79. struct virt_internal_data {
  80. int dev_num;
  81. };
  82. #define DFU_NAME_SIZE 32
  83. #ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
  84. #define CONFIG_SYS_DFU_DATA_BUF_SIZE (1024*1024*8) /* 8 MiB */
  85. #endif
  86. #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
  87. #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
  88. #endif
  89. #ifndef DFU_DEFAULT_POLL_TIMEOUT
  90. #define DFU_DEFAULT_POLL_TIMEOUT 0
  91. #endif
  92. #ifndef DFU_MANIFEST_POLL_TIMEOUT
  93. #define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT
  94. #endif
  95. struct dfu_entity {
  96. char name[DFU_NAME_SIZE];
  97. int alt;
  98. void *dev_private;
  99. enum dfu_device_type dev_type;
  100. enum dfu_layout layout;
  101. unsigned long max_buf_size;
  102. union {
  103. struct mmc_internal_data mmc;
  104. struct mtd_internal_data mtd;
  105. struct nand_internal_data nand;
  106. struct ram_internal_data ram;
  107. struct sf_internal_data sf;
  108. struct virt_internal_data virt;
  109. } data;
  110. int (*get_medium_size)(struct dfu_entity *dfu, u64 *size);
  111. int (*read_medium)(struct dfu_entity *dfu,
  112. u64 offset, void *buf, long *len);
  113. int (*write_medium)(struct dfu_entity *dfu,
  114. u64 offset, void *buf, long *len);
  115. int (*flush_medium)(struct dfu_entity *dfu);
  116. unsigned int (*poll_timeout)(struct dfu_entity *dfu);
  117. void (*free_entity)(struct dfu_entity *dfu);
  118. struct list_head list;
  119. /* on the fly state */
  120. u32 crc;
  121. u64 offset;
  122. int i_blk_seq_num;
  123. u8 *i_buf;
  124. u8 *i_buf_start;
  125. u8 *i_buf_end;
  126. u64 r_left;
  127. long b_left;
  128. u32 bad_skip; /* for nand use */
  129. unsigned int inited:1;
  130. };
  131. #ifdef CONFIG_SET_DFU_ALT_INFO
  132. /**
  133. * set_dfu_alt_info() - set dfu_alt_info environment variable
  134. *
  135. * If CONFIG_SET_DFU_ALT_INFO=y, this board specific function is called to set
  136. * environment variable dfu_alt_info.
  137. *
  138. * @interface: dfu interface, e.g. "mmc" or "nand"
  139. * @devstr: device number as string
  140. */
  141. void set_dfu_alt_info(char *interface, char *devstr);
  142. #endif
  143. /**
  144. * dfu_alt_init() - initialize buffer for dfu entities
  145. *
  146. * @num: number of entities
  147. * @dfu: on return allocated buffer
  148. * Return: 0 on success
  149. */
  150. int dfu_alt_init(int num, struct dfu_entity **dfu);
  151. /**
  152. * dfu_alt_add() - add alternate to dfu entity buffer
  153. *
  154. * @dfu: dfu entity
  155. * @interface: dfu interface, e.g. "mmc" or "nand"
  156. * @devstr: device number as string
  157. * @s: string description of alternate
  158. * Return: 0 on success
  159. */
  160. int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s);
  161. /**
  162. * dfu_config_entities() - initialize dfu entitities from envirionment
  163. *
  164. * Initialize the list of dfu entities from environment variable dfu_alt_info.
  165. * The list must be freed by calling dfu_free_entities(). This function bypasses
  166. * set_dfu_alt_info(). So typically you should use dfu_init_env_entities()
  167. * instead.
  168. *
  169. * See function :c:func:`dfu_free_entities`
  170. * See function :c:func:`dfu_init_env_entities`
  171. *
  172. * @s: string with alternates
  173. * @interface: interface, e.g. "mmc" or "nand"
  174. * @devstr: device number as string
  175. * Return: 0 on success, a negative error code otherwise
  176. */
  177. int dfu_config_entities(char *s, char *interface, char *devstr);
  178. /**
  179. * dfu_free_entities() - free the list of dfu entities
  180. *
  181. * Free the internal list of dfu entities.
  182. *
  183. * See function :c:func:`dfu_init_env_entities`
  184. */
  185. void dfu_free_entities(void);
  186. /**
  187. * dfu_show_entities() - print DFU alt settings list
  188. */
  189. void dfu_show_entities(void);
  190. /**
  191. * dfu_get_alt_number() - get number of alternates
  192. *
  193. * Return: number of alternates in the dfu entities list
  194. */
  195. int dfu_get_alt_number(void);
  196. /**
  197. * dfu_get_dev_type() - get string representation for dfu device type
  198. *
  199. * @type: device type
  200. * Return: string representation for device type
  201. */
  202. const char *dfu_get_dev_type(enum dfu_device_type type);
  203. /**
  204. * dfu_get_layout() - get string describing layout
  205. *
  206. * Internally layouts are represented by enum dfu_device_type values. This
  207. * function translates an enum value to a human readable string, e.g. DFU_FS_FAT
  208. * is translated to "FAT".
  209. *
  210. * @layout: layout
  211. * Result: string representation for the layout
  212. */
  213. const char *dfu_get_layout(enum dfu_layout layout);
  214. /**
  215. * dfu_get_entity() - get dfu entity for an alternate id
  216. *
  217. * @alt: alternate id
  218. * Return: dfu entity
  219. */
  220. struct dfu_entity *dfu_get_entity(int alt);
  221. char *dfu_extract_token(char** e, int *n);
  222. /**
  223. * dfu_get_alt() - get alternate id for filename
  224. *
  225. * Environment variable dfu_alt_info defines the write destinations (alternates)
  226. * for different filenames. This function get the index of the alternate for
  227. * a filename. If an absolute filename is provided (starting with '/'), the
  228. * directory path is ignored.
  229. *
  230. * @name: filename
  231. * Return: id of the alternate or negative error number (-ENODEV)
  232. */
  233. int dfu_get_alt(char *name);
  234. /**
  235. * dfu_init_env_entities() - initialize dfu entitities from envirionment
  236. *
  237. * Initialize the list of dfu entities from environment variable dfu_alt_info.
  238. * The list must be freed by calling dfu_free_entities().
  239. * @interface and @devstr are used to select the relevant set of alternates
  240. * from environment variable dfu_alt_info.
  241. *
  242. * If environment variable dfu_alt_info specifies the interface and the device,
  243. * use NULL for @interface and @devstr.
  244. *
  245. * See function :c:func:`dfu_free_entities`
  246. *
  247. * @interface: interface, e.g. "mmc" or "nand"
  248. * @devstr: device number as string
  249. * Return: 0 on success, a negative error code otherwise
  250. */
  251. int dfu_init_env_entities(char *interface, char *devstr);
  252. unsigned char *dfu_get_buf(struct dfu_entity *dfu);
  253. unsigned char *dfu_free_buf(void);
  254. unsigned long dfu_get_buf_size(void);
  255. bool dfu_usb_get_reset(void);
  256. #ifdef CONFIG_DFU_TIMEOUT
  257. unsigned long dfu_get_timeout(void);
  258. void dfu_set_timeout(unsigned long);
  259. #endif
  260. /**
  261. * dfu_read() - read from dfu entity
  262. *
  263. * The block sequence number @blk_seq_num is a 16 bit counter that must be
  264. * incremented with each call for the same dfu entity @de.
  265. *
  266. * @de: dfu entity
  267. * @buf: buffer
  268. * @size: size of buffer
  269. * @blk_seq_num: block sequence number
  270. * Return: 0 for success, -1 for error
  271. */
  272. int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
  273. /**
  274. * dfu_write() - write to dfu entity
  275. *
  276. * Write the contents of a buffer @buf to the dfu entity @de. After writing
  277. * the last block call dfu_flush(). If a file is already loaded completely
  278. * into memory it is preferable to use dfu_write_from_mem_addr() which takes
  279. * care of blockwise transfer and flushing.
  280. *
  281. * The block sequence number @blk_seq_num is a 16 bit counter that must be
  282. * incremented with each call for the same dfu entity @de.
  283. *
  284. * See function :c:func:`dfu_flush`
  285. * See function :c:func:`dfu_write_from_mem_addr`
  286. *
  287. * @de: dfu entity
  288. * @buf: buffer
  289. * @size: size of buffer
  290. * @blk_seq_num: block sequence number
  291. * Return: 0 for success, -1 for error
  292. */
  293. int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
  294. /**
  295. * dfu_flush() - flush to dfu entity
  296. *
  297. * This function has to be called after writing the last block to the dfu
  298. * entity @de.
  299. *
  300. * The block sequence number @blk_seq_num is a 16 bit counter that must be
  301. * incremented with each call for the same dfu entity @de.
  302. *
  303. * See function :c:func:`dfu_write`
  304. *
  305. * @de: dfu entity
  306. * @buf: ignored
  307. * @size: ignored
  308. * @blk_seq_num: block sequence number of last write - ignored
  309. * Return: 0 for success, -1 for error
  310. */
  311. int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
  312. /**
  313. * dfu_initiated_callback() - weak callback called on DFU transaction start
  314. *
  315. * It is a callback function called by DFU stack when a DFU transaction is
  316. * initiated. This function allows to manage some board specific behavior on
  317. * DFU targets.
  318. *
  319. * @dfu: pointer to the dfu_entity, which should be initialized
  320. */
  321. void dfu_initiated_callback(struct dfu_entity *dfu);
  322. /**
  323. * dfu_flush_callback() - weak callback called at the end of the DFU write
  324. *
  325. * It is a callback function called by DFU stack after DFU manifestation.
  326. * This function allows to manage some board specific behavior on DFU targets
  327. *
  328. * @dfu: pointer to the dfu_entity, which should be flushed
  329. */
  330. void dfu_flush_callback(struct dfu_entity *dfu);
  331. int dfu_transaction_initiate(struct dfu_entity *dfu, bool read);
  332. void dfu_transaction_cleanup(struct dfu_entity *dfu);
  333. /*
  334. * dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
  335. * It should be NULL when not used.
  336. */
  337. extern struct dfu_entity *dfu_defer_flush;
  338. /**
  339. * dfu_get_defer_flush() - get current value of dfu_defer_flush pointer
  340. *
  341. * Return: value of the dfu_defer_flush pointer
  342. */
  343. static inline struct dfu_entity *dfu_get_defer_flush(void)
  344. {
  345. return dfu_defer_flush;
  346. }
  347. /**
  348. * dfu_set_defer_flush() - set the dfu_defer_flush pointer
  349. *
  350. * @dfu: pointer to the dfu_entity, which should be written
  351. */
  352. static inline void dfu_set_defer_flush(struct dfu_entity *dfu)
  353. {
  354. dfu_defer_flush = dfu;
  355. }
  356. /**
  357. * dfu_write_from_mem_addr() - write data from memory to DFU managed medium
  358. *
  359. * This function adds support for writing data starting from fixed memory
  360. * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system)
  361. *
  362. * @dfu: dfu entity to which we want to store data
  363. * @buf: fixed memory address from where data starts
  364. * @size: number of bytes to write
  365. *
  366. * Return: 0 on success, other value on failure
  367. */
  368. int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size);
  369. /* Device specific */
  370. #if CONFIG_IS_ENABLED(DFU_MMC)
  371. extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, char *s);
  372. #else
  373. static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
  374. char *s)
  375. {
  376. puts("MMC support not available!\n");
  377. return -1;
  378. }
  379. #endif
  380. #if CONFIG_IS_ENABLED(DFU_NAND)
  381. extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s);
  382. #else
  383. static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
  384. char *s)
  385. {
  386. puts("NAND support not available!\n");
  387. return -1;
  388. }
  389. #endif
  390. #if CONFIG_IS_ENABLED(DFU_RAM)
  391. extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s);
  392. #else
  393. static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
  394. char *s)
  395. {
  396. puts("RAM support not available!\n");
  397. return -1;
  398. }
  399. #endif
  400. #if CONFIG_IS_ENABLED(DFU_SF)
  401. extern int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr, char *s);
  402. #else
  403. static inline int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr,
  404. char *s)
  405. {
  406. puts("SF support not available!\n");
  407. return -1;
  408. }
  409. #endif
  410. #if CONFIG_IS_ENABLED(DFU_MTD)
  411. int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr, char *s);
  412. #else
  413. static inline int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr,
  414. char *s)
  415. {
  416. puts("MTD support not available!\n");
  417. return -1;
  418. }
  419. #endif
  420. #ifdef CONFIG_DFU_VIRT
  421. int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr, char *s);
  422. int dfu_write_medium_virt(struct dfu_entity *dfu, u64 offset,
  423. void *buf, long *len);
  424. int dfu_get_medium_size_virt(struct dfu_entity *dfu, u64 *size);
  425. int dfu_read_medium_virt(struct dfu_entity *dfu, u64 offset,
  426. void *buf, long *len);
  427. #else
  428. static inline int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr,
  429. char *s)
  430. {
  431. puts("VIRT support not available!\n");
  432. return -1;
  433. }
  434. #endif
  435. /**
  436. * dfu_tftp_write() - write TFTP data to DFU medium
  437. *
  438. * This function is storing data received via TFTP on DFU supported medium.
  439. *
  440. * @dfu_entity_name: name of DFU entity to write
  441. * @addr: address of data buffer to write
  442. * @len: number of bytes
  443. * @interface: destination DFU medium (e.g. "mmc")
  444. * @devstring: instance number of destination DFU medium (e.g. "1")
  445. *
  446. * Return: 0 on success, otherwise error code
  447. */
  448. #if CONFIG_IS_ENABLED(DFU_TFTP)
  449. int dfu_tftp_write(char *dfu_entity_name, unsigned int addr, unsigned int len,
  450. char *interface, char *devstring);
  451. #else
  452. static inline int dfu_tftp_write(char *dfu_entity_name, unsigned int addr,
  453. unsigned int len, char *interface,
  454. char *devstring)
  455. {
  456. puts("TFTP write support for DFU not available!\n");
  457. return -ENOSYS;
  458. }
  459. #endif
  460. int dfu_add(struct usb_configuration *c);
  461. #endif /* __DFU_ENTITY_H_ */