1 #ifndef __ALT_FLASH_DEV_H__
2 /******************************************************************************
3 * *
4 * License Agreement *
5 * *
6 * Copyright (c) 2015 Altera Corporation, San Jose, California, USA. *
7 * All rights reserved. *
8 * *
9 * Permission is hereby granted, free of charge, to any person obtaining a *
10 * copy of this software and associated documentation files (the "Software"), *
11 * to deal in the Software without restriction, including without limitation *
12 * the rights to use, copy, modify, merge, publish, distribute, sublicense, *
13 * and/or sell copies of the Software, and to permit persons to whom the *
14 * Software is furnished to do so, subject to the following conditions: *
15 * *
16 * The above copyright notice and this permission notice shall be included in *
17 * all copies or substantial portions of the Software. *
18 * *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING *
24 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER *
25 * DEALINGS IN THE SOFTWARE. *
26 * *
27 * *
28 * Altera does not recommend, suggest or require that this reference design *
29 * file be used in conjunction or combination with any other product. *
30 ******************************************************************************/
31
32 /******************************************************************************
33 * *
34 * THIS IS A LIBRARY READ-ONLY SOURCE FILE. DO NOT EDIT. *
35 * *
36 ******************************************************************************/
37
38 /******************************************************************************
39 * *
40 * Alt_flash_dev.h - Generic Flash device interfaces *
41 * *
42 * Author PRR *
43 * *
44 ******************************************************************************/
45 #define __ALT_FLASH_DEV_H__
46
47 #include "alt_flash_types.h"
48 #include "sys/alt_llist.h"
49 #include "priv/alt_dev_llist.h"
50
51 #include "alt_types.h"
52
53 typedef struct alt_flash_dev alt_flash_dev;
54 typedef alt_flash_dev alt_flash_fd;
55
alt_flash_device_register(alt_flash_fd * fd)56 static ALT_INLINE int alt_flash_device_register( alt_flash_fd* fd)
57 {
58 extern alt_llist alt_flash_dev_list;
59
60 return alt_dev_llist_insert ((alt_dev_llist*) fd, &alt_flash_dev_list);
61 }
62
63 typedef alt_flash_dev* (*alt_flash_open)(alt_flash_dev* flash,
64 const char* name );
65 typedef int (*alt_flash_close)(alt_flash_dev* flash_info);
66
67 typedef int (*alt_flash_write)( alt_flash_dev* flash, int offset,
68 const void* src_addr, int length );
69
70 typedef int (*alt_flash_get_flash_info)( alt_flash_dev* flash, flash_region** info,
71 int* number_of_regions);
72 typedef int (*alt_flash_write_block)( alt_flash_dev* flash, int block_offset,
73 int data_offset, const void* data,
74 int length);
75 typedef int (*alt_flash_erase_block)( alt_flash_dev* flash, int offset);
76 typedef int (*alt_flash_read)(alt_flash_dev* flash, int offset,
77 void* dest_addr, int length );
78 typedef int (*alt_flash_lock)(alt_flash_dev* flash, alt_u32 sectors_to_lock);
79
80 struct alt_flash_dev
81 {
82 alt_llist llist;
83 const char* name;
84 alt_flash_open open;
85 alt_flash_close close;
86 alt_flash_write write;
87 alt_flash_read read;
88 alt_flash_get_flash_info get_info;
89 alt_flash_erase_block erase_block;
90 alt_flash_write_block write_block;
91 void* base_addr;
92 int length;
93 int number_of_regions;
94 flash_region region_info[ALT_MAX_NUMBER_OF_FLASH_REGIONS];
95 alt_flash_lock lock;
96 };
97
98 #endif /* __ALT_FLASH_DEV_H__ */
99
