blob: 36e8c8aa2fb13db653417a835eb2936abe55dcc0 [file] [log] [blame]
Tanya Brokhman1c94f1a2015-02-15 09:05:03 +02001/* Copyright (c) 2014-2015, The Linux Foundation. All rights reserved.
2 *
3 * Redistribution and use in source and binary forms, with or without
4 * modification, are permitted provided that the following conditions are
5 * met:
6 * * Redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer.
8 * * Redistributions in binary form must reproduce the above
9 * copyright notice, this list of conditions and the following
10 * disclaimer in the documentation and/or other materials provided
11 * with the distribution.
12 * * Neither the name of The Linux Foundation nor the names of its
13 * contributors may be used to endorse or promote products derived
14 * from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
17 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
20 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
23 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
25 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
26 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#ifndef _FLASH_UBI_H_
30#define _FLASH_UBI_H_
31
32#include <sys/types.h>
33#include <lib/ptable.h>
34#include <stdint.h>
35
36/* Erase counter header magic number (ASCII "UBI#") */
37#define UBI_EC_HDR_MAGIC 0x55424923
38
39#define UBI_MAGIC "UBI#"
40#define UBI_MAGIC_SIZE 0x04
41
Tanya Brokhmanea981a32015-02-12 16:32:15 +020042#define UBI_VERSION 1
43#define UBI_MAX_ERASECOUNTER 0x7FFFFFFF
44#define UBI_IMAGE_SEQ_BASE 0x12345678
45#define UBI_DEF_ERACE_COUNTER 0
46#define UBI_CRC32_INIT 0xFFFFFFFFU
47
48/* Erase counter header fields */
49struct __attribute__ ((packed)) ubi_ec_hdr {
50 uint32_t magic;
51 uint8_t version;
52 uint8_t padding1[3];
53 uint64_t ec; /* Warning: the current limit is 31-bit anyway! */
54 uint32_t vid_hdr_offset;
55 uint32_t data_offset;
56 uint32_t image_seq;
57 uint8_t padding2[32];
58 uint32_t hdr_crc;
59};
60
61#define UBI_EC_HDR_SIZE sizeof(struct ubi_ec_hdr)
62#define UBI_EC_HDR_SIZE_CRC (UBI_EC_HDR_SIZE - sizeof(uint32_t))
63
64/**
65 * struct ubi_scan_info - UBI scanning information.
66 * @ec: erase counters or eraseblock status for all eraseblocks
67 * @mean_ec: mean erase counter
68 * @bad_cnt: count of bad eraseblocks
69 * @good_cnt: count of non-bad eraseblocks
70 * @empty_cnt: count of empty eraseblocks
71 * @vid_hdr_offs: volume ID header offset from the found EC headers (%-1 means
72 * undefined)
73 * @data_offs: data offset from the found EC headers (%-1 means undefined)
74 * @image_seq: image sequence
75 */
76struct ubi_scan_info {
77 uint64_t *ec;
78 uint64_t mean_ec;
79 int bad_cnt;
80 int good_cnt;
81 int empty_cnt;
82 unsigned vid_hdr_offs;
83 unsigned data_offs;
84 uint32_t image_seq;
85};
86
87int flash_ubi_img(struct ptentry *ptn, void *data, unsigned size);
Tanya Brokhman1c94f1a2015-02-15 09:05:03 +020088#endif