272a245764a5319b76c1bd24a0b97a8cecfa58bc
[oweals/u-boot.git] / include / dfu.h
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 static inline unsigned int get_mmc_blk_size(int dev)
68 {
69         return find_mmc_device(dev)->read_bl_len;
70 }
71
72 #define DFU_NAME_SIZE                   32
73 #define DFU_CMD_BUF_SIZE                128
74 #ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
75 #define CONFIG_SYS_DFU_DATA_BUF_SIZE            (1024*1024*8)   /* 8 MiB */
76 #endif
77 #ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
78 #define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
79 #endif
80 #ifndef DFU_DEFAULT_POLL_TIMEOUT
81 #define DFU_DEFAULT_POLL_TIMEOUT 0
82 #endif
83
84 struct dfu_entity {
85         char                    name[DFU_NAME_SIZE];
86         int                     alt;
87         void                    *dev_private;
88         int                     dev_num;
89         enum dfu_device_type    dev_type;
90         enum dfu_layout         layout;
91
92         union {
93                 struct mmc_internal_data mmc;
94                 struct nand_internal_data nand;
95                 struct ram_internal_data ram;
96         } data;
97
98         int (*read_medium)(struct dfu_entity *dfu,
99                         u64 offset, void *buf, long *len);
100
101         int (*write_medium)(struct dfu_entity *dfu,
102                         u64 offset, void *buf, long *len);
103
104         int (*flush_medium)(struct dfu_entity *dfu);
105
106         struct list_head list;
107
108         /* on the fly state */
109         u32 crc;
110         u64 offset;
111         int i_blk_seq_num;
112         u8 *i_buf;
113         u8 *i_buf_start;
114         u8 *i_buf_end;
115         long r_left;
116         long b_left;
117
118         u32 bad_skip;   /* for nand use */
119
120         unsigned int inited:1;
121 };
122
123 int dfu_config_entities(char *s, char *interface, int num);
124 void dfu_free_entities(void);
125 void dfu_show_entities(void);
126 int dfu_get_alt_number(void);
127 const char *dfu_get_dev_type(enum dfu_device_type t);
128 const char *dfu_get_layout(enum dfu_layout l);
129 struct dfu_entity *dfu_get_entity(int alt);
130 char *dfu_extract_token(char** e, int *n);
131 void dfu_trigger_reset(void);
132 int dfu_get_alt(char *name);
133 bool dfu_reset(void);
134 int dfu_init_env_entities(char *interface, int dev);
135 unsigned char *dfu_get_buf(void);
136 unsigned char *dfu_free_buf(void);
137 unsigned long dfu_get_buf_size(void);
138
139 int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
140 int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
141 int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
142 /* Device specific */
143 #ifdef CONFIG_DFU_MMC
144 extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s);
145 #else
146 static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s)
147 {
148         puts("MMC support not available!\n");
149         return -1;
150 }
151 #endif
152
153 #ifdef CONFIG_DFU_NAND
154 extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s);
155 #else
156 static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s)
157 {
158         puts("NAND support not available!\n");
159         return -1;
160 }
161 #endif
162
163 #ifdef CONFIG_DFU_RAM
164 extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *s);
165 #else
166 static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *s)
167 {
168         puts("RAM support not available!\n");
169         return -1;
170 }
171 #endif
172
173 #ifdef CONFIG_DFU_FUNCTION
174 int dfu_add(struct usb_configuration *c);
175 #else
176 int dfu_add(struct usb_configuration *c)
177 {
178         return 0;
179 }
180 #endif
181 #endif /* __DFU_ENTITY_H_ */