blob: 6c71ecbe3555377fd83eefc2f0fdd3a7a173646b [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>
Lukasz Majewskia6921ad2013-09-17 15:58:23 +020017#include <linux/usb/composite.h>
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020018
19enum dfu_device_type {
20 DFU_DEV_MMC = 1,
21 DFU_DEV_ONENAND,
22 DFU_DEV_NAND,
Afzal Mohammeda9479f02013-09-18 01:15:24 +053023 DFU_DEV_RAM,
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020024};
25
26enum dfu_layout {
27 DFU_RAW_ADDR = 1,
28 DFU_FS_FAT,
29 DFU_FS_EXT2,
30 DFU_FS_EXT3,
31 DFU_FS_EXT4,
Afzal Mohammeda9479f02013-09-18 01:15:24 +053032 DFU_RAM_ADDR,
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020033};
34
Afzal Mohammed5a127c82013-09-18 01:14:50 +053035enum dfu_op {
36 DFU_OP_READ = 1,
37 DFU_OP_WRITE,
38};
39
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020040struct 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
Pantelis Antoniouc6631762013-03-14 05:32:52 +000051struct nand_internal_data {
52 /* RAW programming */
53 u64 start;
54 u64 size;
55
56 unsigned int dev;
57 unsigned int part;
Heiko Schocher815c30b2013-07-25 06:43:11 +020058 /* for nand/ubi use */
59 unsigned int ubi;
Pantelis Antoniouc6631762013-03-14 05:32:52 +000060};
61
Afzal Mohammeda9479f02013-09-18 01:15:24 +053062struct ram_internal_data {
63 void *start;
64 unsigned int size;
65};
66
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020067static inline unsigned int get_mmc_blk_size(int dev)
68{
69 return find_mmc_device(dev)->read_bl_len;
70}
71
Tom Rinia24c3152013-03-14 05:32:49 +000072#define DFU_NAME_SIZE 32
73#define DFU_CMD_BUF_SIZE 128
Heiko Schochere7e75c72013-06-12 06:05:51 +020074#ifndef CONFIG_SYS_DFU_DATA_BUF_SIZE
75#define CONFIG_SYS_DFU_DATA_BUF_SIZE (1024*1024*8) /* 8 MiB */
76#endif
Pantelis Antoniouea2453d2013-03-14 05:32:48 +000077#ifndef CONFIG_SYS_DFU_MAX_FILE_SIZE
Lukasz Majewski7a813d52013-09-10 15:29:23 +020078#define CONFIG_SYS_DFU_MAX_FILE_SIZE CONFIG_SYS_DFU_DATA_BUF_SIZE
Pantelis Antoniouea2453d2013-03-14 05:32:48 +000079#endif
Lukasz Majewski33fac4a2013-12-09 16:20:14 +010080#ifndef DFU_DEFAULT_POLL_TIMEOUT
81#define DFU_DEFAULT_POLL_TIMEOUT 0
82#endif
Heiko Schocher001a8312014-03-18 08:09:56 +010083#ifndef DFU_MANIFEST_POLL_TIMEOUT
84#define DFU_MANIFEST_POLL_TIMEOUT DFU_DEFAULT_POLL_TIMEOUT
85#endif
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020086
87struct dfu_entity {
88 char name[DFU_NAME_SIZE];
89 int alt;
90 void *dev_private;
91 int dev_num;
92 enum dfu_device_type dev_type;
93 enum dfu_layout layout;
94
95 union {
96 struct mmc_internal_data mmc;
Pantelis Antoniouc6631762013-03-14 05:32:52 +000097 struct nand_internal_data nand;
Afzal Mohammeda9479f02013-09-18 01:15:24 +053098 struct ram_internal_data ram;
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020099 } data;
100
Pantelis Antoniouea2453d2013-03-14 05:32:48 +0000101 int (*read_medium)(struct dfu_entity *dfu,
102 u64 offset, void *buf, long *len);
103
104 int (*write_medium)(struct dfu_entity *dfu,
105 u64 offset, void *buf, long *len);
106
107 int (*flush_medium)(struct dfu_entity *dfu);
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200108
109 struct list_head list;
Pantelis Antoniouea2453d2013-03-14 05:32:48 +0000110
111 /* on the fly state */
112 u32 crc;
113 u64 offset;
114 int i_blk_seq_num;
115 u8 *i_buf;
116 u8 *i_buf_start;
117 u8 *i_buf_end;
118 long r_left;
119 long b_left;
120
Pantelis Antoniouc6631762013-03-14 05:32:52 +0000121 u32 bad_skip; /* for nand use */
122
Pantelis Antoniouea2453d2013-03-14 05:32:48 +0000123 unsigned int inited:1;
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200124};
125
126int dfu_config_entities(char *s, char *interface, int num);
127void dfu_free_entities(void);
128void dfu_show_entities(void);
129int dfu_get_alt_number(void);
130const char *dfu_get_dev_type(enum dfu_device_type t);
131const char *dfu_get_layout(enum dfu_layout l);
132struct dfu_entity *dfu_get_entity(int alt);
133char *dfu_extract_token(char** e, int *n);
Lukasz Majewski6bed7ce2013-07-18 13:19:14 +0200134void dfu_trigger_reset(void);
Lukasz Majewskifed936e2013-10-08 14:30:38 +0200135int dfu_get_alt(char *name);
Lukasz Majewski6bed7ce2013-07-18 13:19:14 +0200136bool dfu_reset(void);
Lukasz Majewski765c5ae2013-09-11 14:53:35 +0200137int dfu_init_env_entities(char *interface, int dev);
Lukasz Majewskid4278262013-10-08 14:30:39 +0200138unsigned char *dfu_get_buf(void);
139unsigned char *dfu_free_buf(void);
Lukasz Majewski4fb12782013-12-09 16:20:13 +0100140unsigned long dfu_get_buf_size(void);
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200141
142int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
143int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
Heiko Schochera2199af2014-03-18 08:09:55 +0100144int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200145/* Device specific */
146#ifdef CONFIG_DFU_MMC
147extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s);
148#else
149static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s)
150{
151 puts("MMC support not available!\n");
152 return -1;
153}
154#endif
Pantelis Antoniouc6631762013-03-14 05:32:52 +0000155
156#ifdef CONFIG_DFU_NAND
157extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s);
158#else
159static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s)
160{
161 puts("NAND support not available!\n");
162 return -1;
163}
164#endif
165
Afzal Mohammeda9479f02013-09-18 01:15:24 +0530166#ifdef CONFIG_DFU_RAM
167extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *s);
168#else
169static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *s)
170{
171 puts("RAM support not available!\n");
172 return -1;
173}
174#endif
175
Lukasz Majewskia6921ad2013-09-17 15:58:23 +0200176#ifdef CONFIG_DFU_FUNCTION
177int dfu_add(struct usb_configuration *c);
178#else
179int dfu_add(struct usb_configuration *c)
180{
181 return 0;
182}
183#endif
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200184#endif /* __DFU_ENTITY_H_ */