1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
/*
* Copyright (c) International Business Machines Corp., 2006
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
* the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
* Author: Frank Haverkamp
*
* An utility to update UBI volumes.
*/
#ifndef __UBIGEN_H__
#define __UBIGEN_H__
#include <stdio.h>
#include <stdint.h>
#include <mtd/ubi-header.h>
#include <asm/byteorder.h>
#ifdef __cplusplus
extern "C" {
#endif
#define DEFAULT_BLOCKSIZE (128 * 1024)
#define DEFAULT_PAGESIZE (2*1024)
#define EUBIGEN_INVALID_TYPE 1
#define EUBIGEN_INVALID_HDR_OFFSET 2
#define EUBIGEN_INVALID_ALIGNMENT 3
#define EUBIGEN_TOO_SMALL_EB 4
#define EUBIGEN_MAX_ERROR 5
typedef enum action {
NO_ERROR = 0x00000000,
BROKEN_HDR_CRC = 0x00000001,
BROKEN_DATA_CRC = 0x00000002,
BROKEN_DATA_SIZE = 0x00000004,
BROKEN_OMIT_BLK = 0x00000008,
MARK_AS_UPDATE = 0x00000010,
} ubigen_action_t;
typedef struct ubi_info *ubi_info_t;
/**
* @brief Initialize the internal CRC32 table.
* @note Necessary because of the used crc32 function in UBI.
* A usage of CRC32, from e.g. zlib will fail.
*/
void ubigen_init(void);
/**
* @brief Create an ubigen handle.
* @param ...
* @return 0 On sucess.
* else Error.
* @note This parameterlist is ugly. But we have to use
* two big structs and meta information internally,
* filling them would be even uglier.
*/
int ubigen_create(ubi_info_t *u, uint32_t vol_id, uint8_t vol_type,
uint32_t eb_size, uint64_t ec, uint32_t alignment,
uint8_t version, uint32_t vid_hdr_offset,
uint8_t compat_flag, size_t data_size,
FILE* fp_in, FILE* fp_out);
/**
* @brief Destroy an ubigen handle.
* @param u Handle to free.
* @return 0 On success.
* else Error.
*/
int ubigen_destroy(ubi_info_t *u);
/**
* @brief Get number of total logical EBs, necessary for the
* complete storage of data in the handle.
* @param u The handle.
* @return 0 On success.
* else Error.
*/
int ubigen_get_leb_total(ubi_info_t u, size_t* total);
/**
* @brief Get the size in bytes of one logical EB in the handle.
* @param u The handle.
* @return 0 On success.
* else Error.
*/
int ubigen_get_leb_size(ubi_info_t u, size_t* size);
/**
* @brief Write a logical EB (fits exactly into 1 physical EB).
* @param u Handle which holds all necessary data.
* @param action Additional operations which shall be applied on this
* logical eraseblock. Mostly injecting artifical errors.
* @return 0 On success.
* else Error.
*/
int ubigen_write_leb(ubi_info_t u, ubigen_action_t action);
/**
* @brief Write a complete array of logical eraseblocks at once.
* @param u Handle which holds all necessary data.
* @return 0 On success.
* else Error.
*/
int ubigen_write_complete(ubi_info_t u);
/**
* @brief Write a single block which is extracted from the
* binary input data.
* @param u Handle which holds all necessary data.
* @param blk Logical eraseblock which shall hold a inc. copy entry
* and a bad data crc.
* @return 0 On success.
* else Error.
*/
int ubigen_write_broken_update(ubi_info_t u, uint32_t blk);
/**
* @brief Use the current ubi_info data and some additional data
* to set an UBI volume table entry from it.
* @param u Handle which holds some of the necessary data.
* @param res_bytes Number of reserved bytes which is stored in the volume
* table entry.
* @param name A string which shall be used as a volume label.
* @param lvol_r A pointer to a volume table entry.
* @return 0 On success.
* else Error.
*/
int ubigen_set_lvol_rec(ubi_info_t u, size_t reserved_bytes,
const char* name, struct ubi_vtbl_record *lvol_rec);
#ifdef __cplusplus
}
#endif
#endif /* !__UBIGEN_H__ */
|
