1 /* 2 * dfu.h - DFU flashable area description 3 * 4 * Copyright (C) 2012 Samsung Electronics 5 * authors: Andrzej Pietrasiewicz <andrzej.p@samsung.com> 6 * Lukasz Majewski <l.majewski@samsung.com> 7 * 8 * SPDX-License-Identifier: GPL-2.0+ 9 */ 10 11 #ifndef __DFU_ENTITY_H_ 12 #define __DFU_ENTITY_H_ 13 14 #include <common.h> 15 #include <linux/list.h> 16 #include <mmc.h> 17 #include <linux/usb/composite.h> 18 19 enum dfu_device_type { 20 DFU_DEV_MMC = 1, 21 DFU_DEV_ONENAND, 22 DFU_DEV_NAND, 23 DFU_DEV_RAM, 24 }; 25 26 enum dfu_layout { 27 DFU_RAW_ADDR = 1, 28 DFU_FS_FAT, 29 DFU_FS_EXT2, 30 DFU_FS_EXT3, 31 DFU_FS_EXT4, 32 DFU_RAM_ADDR, 33 }; 34 35 enum dfu_op { 36 DFU_OP_READ = 1, 37 DFU_OP_WRITE, 38 }; 39 40 struct mmc_internal_data { 41 /* RAW programming */ 42 unsigned int lba_start; 43 unsigned int lba_size; 44 unsigned int lba_blk_size; 45 46 /* FAT/EXT */ 47 unsigned int dev; 48 unsigned int part; 49 }; 50 51 struct nand_internal_data { 52 /* RAW programming */ 53 u64 start; 54 u64 size; 55 56 unsigned int dev; 57 unsigned int part; 58 /* for nand/ubi use */ 59 unsigned int ubi; 60 }; 61 62 struct ram_internal_data { 63 void *start; 64 unsigned int size; 65 }; 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 82 struct dfu_entity { 83 char name[DFU_NAME_SIZE]; 84 int alt; 85 void *dev_private; 86 int dev_num; 87 enum dfu_device_type dev_type; 88 enum dfu_layout layout; 89 90 union { 91 struct mmc_internal_data mmc; 92 struct nand_internal_data nand; 93 struct ram_internal_data ram; 94 } data; 95 96 int (*read_medium)(struct dfu_entity *dfu, 97 u64 offset, void *buf, long *len); 98 99 int (*write_medium)(struct dfu_entity *dfu, 100 u64 offset, void *buf, long *len); 101 102 int (*flush_medium)(struct dfu_entity *dfu); 103 104 struct list_head list; 105 106 /* on the fly state */ 107 u32 crc; 108 u64 offset; 109 int i_blk_seq_num; 110 u8 *i_buf; 111 u8 *i_buf_start; 112 u8 *i_buf_end; 113 long r_left; 114 long b_left; 115 116 u32 bad_skip; /* for nand use */ 117 118 unsigned int inited:1; 119 }; 120 121 int dfu_config_entities(char *s, char *interface, int num); 122 void dfu_free_entities(void); 123 void dfu_show_entities(void); 124 int dfu_get_alt_number(void); 125 const char *dfu_get_dev_type(enum dfu_device_type t); 126 const char *dfu_get_layout(enum dfu_layout l); 127 struct dfu_entity *dfu_get_entity(int alt); 128 char *dfu_extract_token(char** e, int *n); 129 void dfu_trigger_reset(void); 130 int dfu_get_alt(char *name); 131 bool dfu_reset(void); 132 int dfu_init_env_entities(char *interface, int dev); 133 unsigned char *dfu_get_buf(void); 134 unsigned char *dfu_free_buf(void); 135 unsigned long dfu_get_buf_size(void); 136 137 int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num); 138 int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num); 139 int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num); 140 /* Device specific */ 141 #ifdef CONFIG_DFU_MMC 142 extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s); 143 #else 144 static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s) 145 { 146 puts("MMC support not available!\n"); 147 return -1; 148 } 149 #endif 150 151 #ifdef CONFIG_DFU_NAND 152 extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s); 153 #else 154 static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s) 155 { 156 puts("NAND support not available!\n"); 157 return -1; 158 } 159 #endif 160 161 #ifdef CONFIG_DFU_RAM 162 extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *s); 163 #else 164 static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *s) 165 { 166 puts("RAM support not available!\n"); 167 return -1; 168 } 169 #endif 170 171 int dfu_add(struct usb_configuration *c); 172 #endif /* __DFU_ENTITY_H_ */ 173