First version
[3rdparty/ote_partner/tlk.git] / include / dev / flash.h
1 /*
2  * Copyright (c) 2008, Google Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *  * Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  *  * Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in
12  *    the documentation and/or other materials provided with the 
13  *    distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
18  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
19  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
22  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
25  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28
29
30 #ifndef __DEV_FLASH_H
31 #define __DEV_FLASH_H
32
33 #include <lib/ptable.h>
34
35 void flash_init(struct ptable *ptable);
36 struct ptable *flash_get_ptable(void);
37
38 /* flash operations */
39 int flash_erase(struct ptentry *ptn);
40 int flash_read_ext(struct ptentry *ptn, unsigned extra_per_page,
41                    unsigned offset, void *data, unsigned bytes);
42 int flash_write(struct ptentry *ptn, unsigned extra_per_page, const void *data,
43                 unsigned bytes);
44
45 static inline int flash_read(struct ptentry *ptn, unsigned offset, void *data,
46                              unsigned bytes)
47 {
48         return flash_read_ext(ptn, 0, offset, data, bytes);
49 }
50
51
52 #endif /* __DEV_FLASH_H */