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