blob: 7e322d9d2764d4091cd00cf87709a33da991c38f [file] [log] [blame]
Lukasz Majewskif22b11c2012-08-06 14:41:07 +02001/*
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 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02008 * SPDX-License-Identifier: GPL-2.0+
Lukasz Majewskif22b11c2012-08-06 14:41:07 +02009 */
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>
Stephen Warren6f12ebf2014-06-11 16:03:36 -060017#include <spi_flash.h>
Lukasz Majewskia6921ad2013-09-17 15:58:23 +020018#include <linux/usb/composite.h>
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020019
20enum dfu_device_type {
21 DFU_DEV_MMC = 1,
22 DFU_DEV_ONENAND,
23 DFU_DEV_NAND,
Afzal Mohammeda9479f02013-09-18 01:15:24 +053024 DFU_DEV_RAM,
Stephen Warren6f12ebf2014-06-11 16:03:36 -060025 DFU_DEV_SF,
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020026};
27
28enum dfu_layout {
29 DFU_RAW_ADDR = 1,
30 DFU_FS_FAT,
31 DFU_FS_EXT2,
32 DFU_FS_EXT3,
33 DFU_FS_EXT4,
Afzal Mohammeda9479f02013-09-18 01:15:24 +053034 DFU_RAM_ADDR,
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020035};
36
Afzal Mohammed5a127c82013-09-18 01:14:50 +053037enum dfu_op {
38 DFU_OP_READ = 1,
39 DFU_OP_WRITE,
Stephen Warren0e285b52014-06-11 12:47:27 -060040 DFU_OP_SIZE,
Afzal Mohammed5a127c82013-09-18 01:14:50 +053041};
42
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020043struct mmc_internal_data {
Stephen Warrendd648272014-06-11 16:03:33 -060044 int dev_num;
45
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020046 /* RAW programming */
47 unsigned int lba_start;
48 unsigned int lba_size;
49 unsigned int lba_blk_size;
50
Lukasz Majewskic8151b42014-05-09 16:58:15 +020051 /* eMMC HW partition access */
52 int hw_partition;
53
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020054 /* FAT/EXT */
55 unsigned int dev;
56 unsigned int part;
57};
58
Pantelis Antoniouc6631762013-03-14 05:32:52 +000059struct nand_internal_data {
60 /* RAW programming */
61 u64 start;
62 u64 size;
63
64 unsigned int dev;
65 unsigned int part;
Heiko Schocher815c30b2013-07-25 06:43:11 +020066 /* for nand/ubi use */
67 unsigned int ubi;
Pantelis Antoniouc6631762013-03-14 05:32:52 +000068};
69
Afzal Mohammeda9479f02013-09-18 01:15:24 +053070struct ram_internal_data {
71 void *start;
72 unsigned int size;
73};
74
Stephen Warren6f12ebf2014-06-11 16:03:36 -060075struct sf_internal_data {
76 struct spi_flash *dev;
77
78 /* RAW programming */
79 u64 start;
80 u64 size;
81};
82
Tom Rinia24c3152013-03-14 05:32:49 +000083#define DFU_NAME_SIZE 32
84#define DFU_CMD_BUF_SIZE 128
Heiko Schochere7e75c72013-06-12 06:05:51 +020085#ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
86#define CONFIG_SYS_DFU_DATA_BUF_SIZE (1024*1024*8) /* 8 MiB */
87#endif
Pantelis Antoniouea2453d2013-03-14 05:32:48 +000088#ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
Lukasz Majewski7a813d52013-09-10 15:29:23 +020089#define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
Pantelis Antoniouea2453d2013-03-14 05:32:48 +000090#endif
Lukasz Majewski33fac4a2013-12-09 16:20:14 +010091#ifndef DFU_DEFAULT_POLL_TIMEOUT
92#define DFU_DEFAULT_POLL_TIMEOUT 0
93#endif
Heiko Schocher001a8312014-03-18 08:09:56 +010094#ifndef DFU_MANIFEST_POLL_TIMEOUT
95#define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT
96#endif
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020097
98struct dfu_entity {
99 char name[DFU_NAME_SIZE];
100 int alt;
101 void *dev_private;
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200102 enum dfu_device_type dev_type;
103 enum dfu_layout layout;
Stephen Warren7ac1b412014-06-11 16:03:34 -0600104 unsigned long max_buf_size;
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200105
106 union {
107 struct mmc_internal_data mmc;
Pantelis Antoniouc6631762013-03-14 05:32:52 +0000108 struct nand_internal_data nand;
Afzal Mohammeda9479f02013-09-18 01:15:24 +0530109 struct ram_internal_data ram;
Stephen Warren6f12ebf2014-06-11 16:03:36 -0600110 struct sf_internal_data sf;
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200111 } data;
112
Patrick Delaunay15970d82017-07-19 16:39:23 +0200113 int (*get_medium_size)(struct dfu_entity *dfu, u64 *size);
Stephen Warren0e285b52014-06-11 12:47:27 -0600114
Pantelis Antoniouea2453d2013-03-14 05:32:48 +0000115 int (*read_medium)(struct dfu_entity *dfu,
116 u64 offset, void *buf, long *len);
117
118 int (*write_medium)(struct dfu_entity *dfu,
119 u64 offset, void *buf, long *len);
120
121 int (*flush_medium)(struct dfu_entity *dfu);
Heiko Schocherfc25fa22014-04-11 07:59:47 +0200122 unsigned int (*poll_timeout)(struct dfu_entity *dfu);
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200123
Stephen Warrencb7bd2e2014-06-11 16:03:35 -0600124 void (*free_entity)(struct dfu_entity *dfu);
125
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200126 struct list_head list;
Pantelis Antoniouea2453d2013-03-14 05:32:48 +0000127
128 /* on the fly state */
129 u32 crc;
130 u64 offset;
131 int i_blk_seq_num;
132 u8 *i_buf;
133 u8 *i_buf_start;
134 u8 *i_buf_end;
Patrick Delaunay15970d82017-07-19 16:39:23 +0200135 u64 r_left;
Pantelis Antoniouea2453d2013-03-14 05:32:48 +0000136 long b_left;
137
Pantelis Antoniouc6631762013-03-14 05:32:52 +0000138 u32 bad_skip; /* for nand use */
139
Pantelis Antoniouea2453d2013-03-14 05:32:48 +0000140 unsigned int inited:1;
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200141};
142
Przemyslaw Marczak899a5282015-02-17 12:24:11 +0100143#ifdef CONFIG_SET_DFU_ALT_INFO
144void set_dfu_alt_info(char *interface, char *devstr);
145#endif
Stephen Warrendd648272014-06-11 16:03:33 -0600146int dfu_config_entities(char *s, char *interface, char *devstr);
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200147void dfu_free_entities(void);
148void dfu_show_entities(void);
149int dfu_get_alt_number(void);
150const char *dfu_get_dev_type(enum dfu_device_type t);
151const char *dfu_get_layout(enum dfu_layout l);
152struct dfu_entity *dfu_get_entity(int alt);
153char *dfu_extract_token(char** e, int *n);
Lukasz Majewski6bed7ce2013-07-18 13:19:14 +0200154void dfu_trigger_reset(void);
Lukasz Majewskifed936e2013-10-08 14:30:38 +0200155int dfu_get_alt(char *name);
Stephen Warrendd648272014-06-11 16:03:33 -0600156int dfu_init_env_entities(char *interface, char *devstr);
Stephen Warren7ac1b412014-06-11 16:03:34 -0600157unsigned char *dfu_get_buf(struct dfu_entity *dfu);
Lukasz Majewskid4278262013-10-08 14:30:39 +0200158unsigned char *dfu_free_buf(void);
Lukasz Majewski4fb12782013-12-09 16:20:13 +0100159unsigned long dfu_get_buf_size(void);
Lukasz Majewski1cc03c52014-08-25 11:07:28 +0200160bool dfu_usb_get_reset(void);
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200161
162int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
163int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
Heiko Schochera2199af2014-03-18 08:09:55 +0100164int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
Lukasz Majewski2092e462015-08-24 00:21:46 +0200165
Lukasz Majewskifc18f8d2016-01-28 16:14:49 +0100166/*
167 * dfu_defer_flush - pointer to store dfu_entity for deferred flashing.
168 * It should be NULL when not used.
169 */
170extern struct dfu_entity *dfu_defer_flush;
171/**
172 * dfu_get_defer_flush - get current value of dfu_defer_flush pointer
173 *
174 * @return - value of the dfu_defer_flush pointer
175 */
176static inline struct dfu_entity *dfu_get_defer_flush(void)
177{
178 return dfu_defer_flush;
179}
180
181/**
182 * dfu_set_defer_flush - set the dfu_defer_flush pointer
183 *
184 * @param dfu - pointer to the dfu_entity, which should be written
185 */
186static inline void dfu_set_defer_flush(struct dfu_entity *dfu)
187{
188 dfu_defer_flush = dfu;
189}
190
Lukasz Majewski2092e462015-08-24 00:21:46 +0200191/**
192 * dfu_write_from_mem_addr - write data from memory to DFU managed medium
193 *
194 * This function adds support for writing data starting from fixed memory
195 * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system)
196 *
197 * @param dfu - dfu entity to which we want to store data
198 * @param buf - fixed memory addres from where data starts
199 * @param size - number of bytes to write
200 *
201 * @return - 0 on success, other value on failure
202 */
203int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size);
204
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200205/* Device specific */
206#ifdef CONFIG_DFU_MMC
Stephen Warrendd648272014-06-11 16:03:33 -0600207extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, char *s);
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200208#else
Stephen Warrendd648272014-06-11 16:03:33 -0600209static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr,
210 char *s)
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200211{
212 puts("MMC support not available!\n");
213 return -1;
214}
215#endif
Pantelis Antoniouc6631762013-03-14 05:32:52 +0000216
217#ifdef CONFIG_DFU_NAND
Stephen Warrendd648272014-06-11 16:03:33 -0600218extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr, char *s);
Pantelis Antoniouc6631762013-03-14 05:32:52 +0000219#else
Stephen Warrendd648272014-06-11 16:03:33 -0600220static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *devstr,
221 char *s)
Pantelis Antoniouc6631762013-03-14 05:32:52 +0000222{
223 puts("NAND support not available!\n");
224 return -1;
225}
226#endif
227
Afzal Mohammeda9479f02013-09-18 01:15:24 +0530228#ifdef CONFIG_DFU_RAM
Stephen Warrendd648272014-06-11 16:03:33 -0600229extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr, char *s);
Afzal Mohammeda9479f02013-09-18 01:15:24 +0530230#else
Stephen Warrendd648272014-06-11 16:03:33 -0600231static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *devstr,
232 char *s)
Afzal Mohammeda9479f02013-09-18 01:15:24 +0530233{
234 puts("RAM support not available!\n");
235 return -1;
236}
237#endif
238
Stephen Warren6f12ebf2014-06-11 16:03:36 -0600239#ifdef CONFIG_DFU_SF
240extern int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr, char *s);
241#else
242static inline int dfu_fill_entity_sf(struct dfu_entity *dfu, char *devstr,
243 char *s)
244{
245 puts("SF support not available!\n");
246 return -1;
247}
248#endif
249
Lukasz Majewski2d50d682015-08-24 00:21:45 +0200250/**
251 * dfu_tftp_write - Write TFTP data to DFU medium
252 *
253 * This function is storing data received via TFTP on DFU supported medium.
254 *
255 * @param dfu_entity_name - name of DFU entity to write
256 * @param addr - address of data buffer to write
257 * @param len - number of bytes
258 * @param interface - destination DFU medium (e.g. "mmc")
259 * @param devstring - instance number of destination DFU medium (e.g. "1")
260 *
261 * @return 0 on success, otherwise error code
262 */
263#ifdef CONFIG_DFU_TFTP
264int dfu_tftp_write(char *dfu_entity_name, unsigned int addr, unsigned int len,
265 char *interface, char *devstring);
266#else
267static inline int dfu_tftp_write(char *dfu_entity_name, unsigned int addr,
268 unsigned int len, char *interface,
269 char *devstring)
270{
271 puts("TFTP write support for DFU not available!\n");
272 return -ENOSYS;
273}
274#endif
275
Lukasz Majewskia6921ad2013-09-17 15:58:23 +0200276int dfu_add(struct usb_configuration *c);
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200277#endif /* __DFU_ENTITY_H_ */