dfu.h 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276
  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. };
  23. enum dfu_layout {
  24. DFU_RAW_ADDR = 1,
  25. DFU_FS_FAT,
  26. DFU_FS_EXT2,
  27. DFU_FS_EXT3,
  28. DFU_FS_EXT4,
  29. DFU_RAM_ADDR,
  30. };
  31. enum dfu_op {
  32. DFU_OP_READ = 1,
  33. DFU_OP_WRITE,
  34. DFU_OP_SIZE,
  35. };
  36. struct mmc_internal_data {
  37. int dev_num;
  38. /* RAW programming */
  39. unsigned int lba_start;
  40. unsigned int lba_size;
  41. unsigned int lba_blk_size;
  42. /* eMMC HW partition access */
  43. int hw_partition;
  44. /* FAT/EXT */
  45. unsigned int dev;
  46. unsigned int part;
  47. };
  48. struct nand_internal_data {
  49. /* RAW programming */
  50. u64 start;
  51. u64 size;
  52. unsigned int dev;
  53. unsigned int part;
  54. /* for nand/ubi use */
  55. unsigned int ubi;
  56. };
  57. struct ram_internal_data {
  58. void *start;
  59. unsigned int size;
  60. };
  61. struct sf_internal_data {
  62. struct spi_flash *dev;
  63. /* RAW programming */
  64. u64 start;
  65. u64 size;
  66. };
  67. #define DFU_NAME_SIZE 32
  68. #define DFU_CMD_BUF_SIZE 128
  69. #ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
  70. #define CONFIG_SYS_DFU_DATA_BUF_SIZE (1024*1024*8) /* 8 MiB */
  71. #endif
  72. #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
  73. #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
  74. #endif
  75. #ifndef DFU_DEFAULT_POLL_TIMEOUT
  76. #define DFU_DEFAULT_POLL_TIMEOUT 0
  77. #endif
  78. #ifndef DFU_MANIFEST_POLL_TIMEOUT
  79. #define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT
  80. #endif
  81. struct dfu_entity {
  82. char name[DFU_NAME_SIZE];
  83. int alt;
  84. void *dev_private;
  85. enum dfu_device_type dev_type;
  86. enum dfu_layout layout;
  87. unsigned long max_buf_size;
  88. union {
  89. struct mmc_internal_data mmc;
  90. struct nand_internal_data nand;
  91. struct ram_internal_data ram;
  92. struct sf_internal_data sf;
  93. } data;
  94. int (*get_medium_size)(struct dfu_entity *dfu, u64 *size);
  95. int (*read_medium)(struct dfu_entity *dfu,
  96. u64 offset, void *buf, long *len);
  97. int (*write_medium)(struct dfu_entity *dfu,
  98. u64 offset, void *buf, long *len);
  99. int (*flush_medium)(struct dfu_entity *dfu);
  100. unsigned int (*poll_timeout)(struct dfu_entity *dfu);
  101. void (*free_entity)(struct dfu_entity *dfu);
  102. struct list_head list;
  103. /* on the fly state */
  104. u32 crc;
  105. u64 offset;
  106. int i_blk_seq_num;
  107. u8 *i_buf;
  108. u8 *i_buf_start;
  109. u8 *i_buf_end;
  110. u64 r_left;
  111. long b_left;
  112. u32 bad_skip; /* for nand use */
  113. unsigned int inited:1;
  114. };
  115. #ifdef CONFIG_SET_DFU_ALT_INFO
  116. void set_dfu_alt_info(char *interface, char *devstr);
  117. #endif
  118. int dfu_config_entities(char *s, char *interface, char *devstr);
  119. void dfu_free_entities(void);
  120. void dfu_show_entities(void);
  121. int dfu_get_alt_number(void);
  122. const char *dfu_get_dev_type(enum dfu_device_type t);
  123. const char *dfu_get_layout(enum dfu_layout l);
  124. struct dfu_entity *dfu_get_entity(int alt);
  125. char *dfu_extract_token(char** e, int *n);
  126. void dfu_trigger_reset(void);
  127. int dfu_get_alt(char *name);
  128. int dfu_init_env_entities(char *interface, char *devstr);
  129. unsigned char *dfu_get_buf(struct dfu_entity *dfu);
  130. unsigned char *dfu_free_buf(void);
  131. unsigned long dfu_get_buf_size(void);
  132. bool dfu_usb_get_reset(void);
  133. int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
  134. int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
  135. int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
  136. /*
  137. * dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
  138. * It should be NULL when not used.
  139. */
  140. extern struct dfu_entity *dfu_defer_flush;
  141. /**
  142. * dfu_get_defer_flush - get current value of dfu_defer_flush pointer
  143. *
  144. * @return - value of the dfu_defer_flush pointer
  145. */
  146. static inline struct dfu_entity *dfu_get_defer_flush(void)
  147. {
  148. return dfu_defer_flush;
  149. }
  150. /**
  151. * dfu_set_defer_flush - set the dfu_defer_flush pointer
  152. *
  153. * @param dfu - pointer to the dfu_entity, which should be written
  154. */
  155. static inline void dfu_set_defer_flush(struct dfu_entity *dfu)
  156. {
  157. dfu_defer_flush = dfu;
  158. }
  159. /**
  160. * dfu_write_from_mem_addr - write data from memory to DFU managed medium
  161. *
  162. * This function adds support for writing data starting from fixed memory
  163. * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system)
  164. *
  165. * @param dfu - dfu entity to which we want to store data
  166. * @param buf - fixed memory addres from where data starts
  167. * @param size - number of bytes to write
  168. *
  169. * @return - 0 on success, other value on failure
  170. */
  171. int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size);
  172. /* Device specific */
  173. #ifdef CONFIG_DFU_MMC
  174. extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, char *s);
  175. #else
  176. static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
  177. char *s)
  178. {
  179. puts("MMC support not available!\n");
  180. return -1;
  181. }
  182. #endif
  183. #ifdef CONFIG_DFU_NAND
  184. extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s);
  185. #else
  186. static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
  187. char *s)
  188. {
  189. puts("NAND support not available!\n");
  190. return -1;
  191. }
  192. #endif
  193. #ifdef CONFIG_DFU_RAM
  194. extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s);
  195. #else
  196. static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
  197. char *s)
  198. {
  199. puts("RAM support not available!\n");
  200. return -1;
  201. }
  202. #endif
  203. #ifdef CONFIG_DFU_SF
  204. extern int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr, char *s);
  205. #else
  206. static inline int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr,
  207. char *s)
  208. {
  209. puts("SF support not available!\n");
  210. return -1;
  211. }
  212. #endif
  213. /**
  214. * dfu_tftp_write - Write TFTP data to DFU medium
  215. *
  216. * This function is storing data received via TFTP on DFU supported medium.
  217. *
  218. * @param dfu_entity_name - name of DFU entity to write
  219. * @param addr - address of data buffer to write
  220. * @param len - number of bytes
  221. * @param interface - destination DFU medium (e.g. "mmc")
  222. * @param devstring - instance number of destination DFU medium (e.g. "1")
  223. *
  224. * @return 0 on success, otherwise error code
  225. */
  226. #ifdef CONFIG_DFU_TFTP
  227. int dfu_tftp_write(char *dfu_entity_name, unsigned int addr, unsigned int len,
  228. char *interface, char *devstring);
  229. #else
  230. static inline int dfu_tftp_write(char *dfu_entity_name, unsigned int addr,
  231. unsigned int len, char *interface,
  232. char *devstring)
  233. {
  234. puts("TFTP write support for DFU not available!\n");
  235. return -ENOSYS;
  236. }
  237. #endif
  238. int dfu_add(struct usb_configuration *c);
  239. #endif /* __DFU_ENTITY_H_ */