dfu.h 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346
  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. void *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. void set_dfu_alt_info(char *interface, char *devstr);
  133. #endif
  134. int dfu_alt_init(int num, struct dfu_entity **dfu);
  135. int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s);
  136. int dfu_config_entities(char *s, char *interface, char *devstr);
  137. void dfu_free_entities(void);
  138. void dfu_show_entities(void);
  139. int dfu_get_alt_number(void);
  140. const char *dfu_get_dev_type(enum dfu_device_type t);
  141. const char *dfu_get_layout(enum dfu_layout l);
  142. struct dfu_entity *dfu_get_entity(int alt);
  143. char *dfu_extract_token(char** e, int *n);
  144. void dfu_trigger_reset(void);
  145. int dfu_get_alt(char *name);
  146. int dfu_init_env_entities(char *interface, char *devstr);
  147. unsigned char *dfu_get_buf(struct dfu_entity *dfu);
  148. unsigned char *dfu_free_buf(void);
  149. unsigned long dfu_get_buf_size(void);
  150. bool dfu_usb_get_reset(void);
  151. int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
  152. int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
  153. int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
  154. /**
  155. * dfu_initiated_callback - weak callback called on DFU transaction start
  156. *
  157. * It is a callback function called by DFU stack when a DFU transaction is
  158. * initiated. This function allows to manage some board specific behavior on
  159. * DFU targets.
  160. *
  161. * @param dfu - pointer to the dfu_entity, which should be initialized
  162. *
  163. */
  164. void dfu_initiated_callback(struct dfu_entity *dfu);
  165. /**
  166. * dfu_flush_callback - weak callback called at the end of the DFU write
  167. *
  168. * It is a callback function called by DFU stack after DFU manifestation.
  169. * This function allows to manage some board specific behavior on DFU targets
  170. *
  171. * @param dfu - pointer to the dfu_entity, which should be flushed
  172. *
  173. */
  174. void dfu_flush_callback(struct dfu_entity *dfu);
  175. /*
  176. * dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
  177. * It should be NULL when not used.
  178. */
  179. extern struct dfu_entity *dfu_defer_flush;
  180. /**
  181. * dfu_get_defer_flush - get current value of dfu_defer_flush pointer
  182. *
  183. * @return - value of the dfu_defer_flush pointer
  184. */
  185. static inline struct dfu_entity *dfu_get_defer_flush(void)
  186. {
  187. return dfu_defer_flush;
  188. }
  189. /**
  190. * dfu_set_defer_flush - set the dfu_defer_flush pointer
  191. *
  192. * @param dfu - pointer to the dfu_entity, which should be written
  193. */
  194. static inline void dfu_set_defer_flush(struct dfu_entity *dfu)
  195. {
  196. dfu_defer_flush = dfu;
  197. }
  198. /**
  199. * dfu_write_from_mem_addr - write data from memory to DFU managed medium
  200. *
  201. * This function adds support for writing data starting from fixed memory
  202. * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system)
  203. *
  204. * @param dfu - dfu entity to which we want to store data
  205. * @param buf - fixed memory addres from where data starts
  206. * @param size - number of bytes to write
  207. *
  208. * @return - 0 on success, other value on failure
  209. */
  210. int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size);
  211. /* Device specific */
  212. #if CONFIG_IS_ENABLED(DFU_MMC)
  213. extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, char *s);
  214. #else
  215. static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
  216. char *s)
  217. {
  218. puts("MMC support not available!\n");
  219. return -1;
  220. }
  221. #endif
  222. #if CONFIG_IS_ENABLED(DFU_NAND)
  223. extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s);
  224. #else
  225. static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
  226. char *s)
  227. {
  228. puts("NAND support not available!\n");
  229. return -1;
  230. }
  231. #endif
  232. #if CONFIG_IS_ENABLED(DFU_RAM)
  233. extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s);
  234. #else
  235. static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
  236. char *s)
  237. {
  238. puts("RAM support not available!\n");
  239. return -1;
  240. }
  241. #endif
  242. #if CONFIG_IS_ENABLED(DFU_SF)
  243. extern int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr, char *s);
  244. #else
  245. static inline int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr,
  246. char *s)
  247. {
  248. puts("SF support not available!\n");
  249. return -1;
  250. }
  251. #endif
  252. #if CONFIG_IS_ENABLED(DFU_MTD)
  253. int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr, char *s);
  254. #else
  255. static inline int dfu_fill_entity_mtd(struct dfu_entity *dfu, char *devstr,
  256. char *s)
  257. {
  258. puts("MTD support not available!\n");
  259. return -1;
  260. }
  261. #endif
  262. #ifdef CONFIG_DFU_VIRT
  263. int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr, char *s);
  264. int dfu_write_medium_virt(struct dfu_entity *dfu, u64 offset,
  265. void *buf, long *len);
  266. int dfu_get_medium_size_virt(struct dfu_entity *dfu, u64 *size);
  267. int dfu_read_medium_virt(struct dfu_entity *dfu, u64 offset,
  268. void *buf, long *len);
  269. #else
  270. static inline int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr,
  271. char *s)
  272. {
  273. puts("VIRT support not available!\n");
  274. return -1;
  275. }
  276. #endif
  277. /**
  278. * dfu_tftp_write - Write TFTP data to DFU medium
  279. *
  280. * This function is storing data received via TFTP on DFU supported medium.
  281. *
  282. * @param dfu_entity_name - name of DFU entity to write
  283. * @param addr - address of data buffer to write
  284. * @param len - number of bytes
  285. * @param interface - destination DFU medium (e.g. "mmc")
  286. * @param devstring - instance number of destination DFU medium (e.g. "1")
  287. *
  288. * @return 0 on success, otherwise error code
  289. */
  290. #if CONFIG_IS_ENABLED(DFU_TFTP)
  291. int dfu_tftp_write(char *dfu_entity_name, unsigned int addr, unsigned int len,
  292. char *interface, char *devstring);
  293. #else
  294. static inline int dfu_tftp_write(char *dfu_entity_name, unsigned int addr,
  295. unsigned int len, char *interface,
  296. char *devstring)
  297. {
  298. puts("TFTP write support for DFU not available!\n");
  299. return -ENOSYS;
  300. }
  301. #endif
  302. int dfu_add(struct usb_configuration *c);
  303. #endif /* __DFU_ENTITY_H_ */