2 * dfu.h - DFU flashable area description
4 * Copyright (C) 2012 Samsung Electronics
5 * authors: Andrzej Pietrasiewicz <andrzej.p@samsung.com>
6 * Lukasz Majewski <l.majewski@samsung.com>
8 * SPDX-License-Identifier: GPL-2.0+
11 #ifndef __DFU_ENTITY_H_
12 #define __DFU_ENTITY_H_
15 #include <linux/list.h>
17 #include <linux/usb/composite.h>
19 enum dfu_device_type {
41 struct mmc_internal_data {
45 unsigned int lba_start;
46 unsigned int lba_size;
47 unsigned int lba_blk_size;
49 /* eMMC HW partition access */
57 struct nand_internal_data {
64 /* for nand/ubi use */
68 struct ram_internal_data {
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 */
78 #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
79 #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
81 #ifndef DFU_DEFAULT_POLL_TIMEOUT
82 #define DFU_DEFAULT_POLL_TIMEOUT 0
84 #ifndef DFU_MANIFEST_POLL_TIMEOUT
85 #define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT
89 char name[DFU_NAME_SIZE];
92 enum dfu_device_type dev_type;
93 enum dfu_layout layout;
94 unsigned long max_buf_size;
97 struct mmc_internal_data mmc;
98 struct nand_internal_data nand;
99 struct ram_internal_data ram;
102 long (*get_medium_size)(struct dfu_entity *dfu);
104 int (*read_medium)(struct dfu_entity *dfu,
105 u64 offset, void *buf, long *len);
107 int (*write_medium)(struct dfu_entity *dfu,
108 u64 offset, void *buf, long *len);
110 int (*flush_medium)(struct dfu_entity *dfu);
111 unsigned int (*poll_timeout)(struct dfu_entity *dfu);
113 void (*free_entity)(struct dfu_entity *dfu);
115 struct list_head list;
117 /* on the fly state */
127 u32 bad_skip; /* for nand use */
129 unsigned int inited:1;
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);
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);
155 static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
158 puts("MMC support not available!\n");
163 #ifdef CONFIG_DFU_NAND
164 extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s);
166 static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
169 puts("NAND support not available!\n");
174 #ifdef CONFIG_DFU_RAM
175 extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s);
177 static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
180 puts("RAM support not available!\n");
185 int dfu_add(struct usb_configuration *c);
186 #endif /* __DFU_ENTITY_H_ */