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 DFU_OP_SIZE, 39 }; 40 41 struct mmc_internal_data { 42 int dev_num; 43 44 /* RAW programming */ 45 unsigned int lba_start; 46 unsigned int lba_size; 47 unsigned int lba_blk_size; 48 49 /* eMMC HW partition access */ 50 int hw_partition; 51 52 /* FAT/EXT */ 53 unsigned int dev; 54 unsigned int part; 55 }; 56 57 struct nand_internal_data { 58 /* RAW programming */ 59 u64 start; 60 u64 size; 61 62 unsigned int dev; 63 unsigned int part; 64 /* for nand/ubi use */ 65 unsigned int ubi; 66 }; 67 68 struct ram_internal_data { 69 void *start; 70 unsigned int size; 71 }; 72 73 #define DFU_NAME_SIZE 32 74 #define DFU_CMD_BUF_SIZE 128 75 #ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE 76 #define CONFIG_SYS_DFU_DATA_BUF_SIZE (1024*1024*8) /* 8 MiB */ 77 #endif 78 #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE 79 #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE 80 #endif 81 #ifndef DFU_DEFAULT_POLL_TIMEOUT 82 #define DFU_DEFAULT_POLL_TIMEOUT 0 83 #endif 84 #ifndef DFU_MANIFEST_POLL_TIMEOUT 85 #define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT 86 #endif 87 88 struct dfu_entity { 89 char name[DFU_NAME_SIZE]; 90 int alt; 91 void *dev_private; 92 enum dfu_device_type dev_type; 93 enum dfu_layout layout; 94 unsigned long max_buf_size; 95 96 union { 97 struct mmc_internal_data mmc; 98 struct nand_internal_data nand; 99 struct ram_internal_data ram; 100 } data; 101 102 long (*get_medium_size)(struct dfu_entity *dfu); 103 104 int (*read_medium)(struct dfu_entity *dfu, 105 u64 offset, void *buf, long *len); 106 107 int (*write_medium)(struct dfu_entity *dfu, 108 u64 offset, void *buf, long *len); 109 110 int (*flush_medium)(struct dfu_entity *dfu); 111 unsigned int (*poll_timeout)(struct dfu_entity *dfu); 112 113 void (*free_entity)(struct dfu_entity *dfu); 114 115 struct list_head list; 116 117 /* on the fly state */ 118 u32 crc; 119 u64 offset; 120 int i_blk_seq_num; 121 u8 *i_buf; 122 u8 *i_buf_start; 123 u8 *i_buf_end; 124 long r_left; 125 long b_left; 126 127 u32 bad_skip; /* for nand use */ 128 129 unsigned int inited:1; 130 }; 131 132 int dfu_config_entities(char *s, char *interface, char *devstr); 133 void dfu_free_entities(void); 134 void dfu_show_entities(void); 135 int dfu_get_alt_number(void); 136 const char *dfu_get_dev_type(enum dfu_device_type t); 137 const char *dfu_get_layout(enum dfu_layout l); 138 struct dfu_entity *dfu_get_entity(int alt); 139 char *dfu_extract_token(char** e, int *n); 140 void dfu_trigger_reset(void); 141 int dfu_get_alt(char *name); 142 bool dfu_reset(void); 143 int dfu_init_env_entities(char *interface, char *devstr); 144 unsigned char *dfu_get_buf(struct dfu_entity *dfu); 145 unsigned char *dfu_free_buf(void); 146 unsigned long dfu_get_buf_size(void); 147 148 int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num); 149 int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num); 150 int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num); 151 /* Device specific */ 152 #ifdef CONFIG_DFU_MMC 153 extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, char *s); 154 #else 155 static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, 156 char *s) 157 { 158 puts("MMC support not available!\n"); 159 return -1; 160 } 161 #endif 162 163 #ifdef CONFIG_DFU_NAND 164 extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s); 165 #else 166 static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, 167 char *s) 168 { 169 puts("NAND support not available!\n"); 170 return -1; 171 } 172 #endif 173 174 #ifdef CONFIG_DFU_RAM 175 extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s); 176 #else 177 static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, 178 char *s) 179 { 180 puts("RAM support not available!\n"); 181 return -1; 182 } 183 #endif 184 185 int dfu_add(struct usb_configuration *c); 186 #endif /* __DFU_ENTITY_H_ */ 187