1/*
2 * Copyright (C) 2007 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef MTDUTILS_H_
18#define MTDUTILS_H_
19
20#include <sys/types.h>  // for size_t, etc.
21
22#ifdef __cplusplus
23extern "C" {
24#endif
25
26typedef struct MtdPartition MtdPartition;
27
28int mtd_scan_partitions(void);
29
30const MtdPartition *mtd_find_partition_by_name(const char *name);
31
32/* mount_point is like "/system"
33 * filesystem is like "yaffs2"
34 */
35int mtd_mount_partition(const MtdPartition *partition, const char *mount_point,
36        const char *filesystem, int read_only);
37
38/* get the partition and the minimum erase/write block size.  NULL is ok.
39 */
40int mtd_partition_info(const MtdPartition *partition,
41        size_t *total_size, size_t *erase_size, size_t *write_size);
42
43/* read or write raw data from a partition, starting at the beginning.
44 * skips bad blocks as best we can.
45 */
46typedef struct MtdReadContext MtdReadContext;
47typedef struct MtdWriteContext MtdWriteContext;
48
49MtdReadContext *mtd_read_partition(const MtdPartition *);
50ssize_t mtd_read_data(MtdReadContext *, char *data, size_t data_len);
51void mtd_read_close(MtdReadContext *);
52void mtd_read_skip_to(const MtdReadContext *, size_t offset);
53
54MtdWriteContext *mtd_write_partition(const MtdPartition *);
55ssize_t mtd_write_data(MtdWriteContext *, const char *data, size_t data_len);
56off_t mtd_erase_blocks(MtdWriteContext *, int blocks);  /* 0 ok, -1 for all */
57off_t mtd_find_write_start(MtdWriteContext *ctx, off_t pos);
58int mtd_write_close(MtdWriteContext *);
59
60#ifdef __cplusplus
61}
62#endif
63
64#endif  // MTDUTILS_H_
65