blob: b14425503d6914549f6722170e06b99458099255 [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 Majewskif22b11c2012-08-06 14:41:07 +020080
81struct dfu_entity {
82 char name[DFU_NAME_SIZE];
83 int alt;
84 void *dev_private;
85 int dev_num;
86 enum dfu_device_type dev_type;
87 enum dfu_layout layout;
88
89 union {
90 struct mmc_internal_data mmc;
Pantelis Antoniouc6631762013-03-14 05:32:52 +000091 struct nand_internal_data nand;
Afzal Mohammeda9479f02013-09-18 01:15:24 +053092 struct ram_internal_data ram;
Lukasz Majewskif22b11c2012-08-06 14:41:07 +020093 } data;
94
Pantelis Antoniouea2453d2013-03-14 05:32:48 +000095 int (*read_medium)(struct dfu_entity *dfu,
96 u64 offset, void *buf, long *len);
97
98 int (*write_medium)(struct dfu_entity *dfu,
99 u64 offset, void *buf, long *len);
100
101 int (*flush_medium)(struct dfu_entity *dfu);
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200102
103 struct list_head list;
Pantelis Antoniouea2453d2013-03-14 05:32:48 +0000104
105 /* on the fly state */
106 u32 crc;
107 u64 offset;
108 int i_blk_seq_num;
109 u8 *i_buf;
110 u8 *i_buf_start;
111 u8 *i_buf_end;
112 long r_left;
113 long b_left;
114
Pantelis Antoniouc6631762013-03-14 05:32:52 +0000115 u32 bad_skip; /* for nand use */
116
Pantelis Antoniouea2453d2013-03-14 05:32:48 +0000117 unsigned int inited:1;
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200118};
119
120int dfu_config_entities(char *s, char *interface, int num);
121void dfu_free_entities(void);
122void dfu_show_entities(void);
123int dfu_get_alt_number(void);
124const char *dfu_get_dev_type(enum dfu_device_type t);
125const char *dfu_get_layout(enum dfu_layout l);
126struct dfu_entity *dfu_get_entity(int alt);
127char *dfu_extract_token(char** e, int *n);
Lukasz Majewski6bed7ce2013-07-18 13:19:14 +0200128void dfu_trigger_reset(void);
Lukasz Majewskifed936e2013-10-08 14:30:38 +0200129int dfu_get_alt(char *name);
Lukasz Majewski6bed7ce2013-07-18 13:19:14 +0200130bool dfu_reset(void);
Lukasz Majewski765c5ae2013-09-11 14:53:35 +0200131int dfu_init_env_entities(char *interface, int dev);
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200132
133int dfu_read(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
134int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num);
135/* Device specific */
136#ifdef CONFIG_DFU_MMC
137extern int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s);
138#else
139static inline int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *s)
140{
141 puts("MMC support not available!\n");
142 return -1;
143}
144#endif
Pantelis Antoniouc6631762013-03-14 05:32:52 +0000145
146#ifdef CONFIG_DFU_NAND
147extern int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s);
148#else
149static inline int dfu_fill_entity_nand(struct dfu_entity *dfu, char *s)
150{
151 puts("NAND support not available!\n");
152 return -1;
153}
154#endif
155
Afzal Mohammeda9479f02013-09-18 01:15:24 +0530156#ifdef CONFIG_DFU_RAM
157extern int dfu_fill_entity_ram(struct dfu_entity *dfu, char *s);
158#else
159static inline int dfu_fill_entity_ram(struct dfu_entity *dfu, char *s)
160{
161 puts("RAM support not available!\n");
162 return -1;
163}
164#endif
165
Lukasz Majewskia6921ad2013-09-17 15:58:23 +0200166#ifdef CONFIG_DFU_FUNCTION
167int dfu_add(struct usb_configuration *c);
168#else
169int dfu_add(struct usb_configuration *c)
170{
171 return 0;
172}
173#endif
Lukasz Majewskif22b11c2012-08-06 14:41:07 +0200174#endif /* __DFU_ENTITY_H_ */