aboutsummaryrefslogtreecommitdiff
path: root/sys/dev/nand/nand_if.m
blob: 49c8879b68902249f56a8e7e5999759ae9c65658 (plain) (blame)
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
#-
# Copyright (C) 2009-2012 Semihalf
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#
# $FreeBSD$

# NAND chip interface description
#

#include <sys/bus.h>
#include <dev/nand/nand.h>

INTERFACE nand;

CODE {
	static int nand_method_not_supported(device_t dev)
	{
		return (ENOENT);
	}
};

# Read NAND page
#
# Return values:
# 0: Success
#
METHOD int read_page {
	device_t dev;
	uint32_t page;
	void* buf;
	uint32_t len;
	uint32_t offset;
};

# Program NAND page
#
# Return values:
# 0: Success
#
METHOD int program_page {
	device_t dev;
	uint32_t page;
	void* buf;
	uint32_t len;
	uint32_t offset;
};

# Program NAND page interleaved
#
# Return values:
# 0: Success
#
METHOD int program_page_intlv {
	device_t dev;
	uint32_t page;
	void* buf;
	uint32_t len;
	uint32_t offset;
} DEFAULT nand_method_not_supported;

# Read NAND oob
#
# Return values:
# 0: Success
#
METHOD int read_oob {
	device_t dev;
	uint32_t page;
	void* buf;
	uint32_t len;
	uint32_t offset;
};

# Program NAND oob
#
# Return values:
# 0: Success
#
METHOD int program_oob {
	device_t dev;
	uint32_t page;
	void* buf;
	uint32_t len;
	uint32_t offset;
};

# Erase NAND block
#
# Return values:
# 0: Success
#
METHOD int erase_block {
	device_t dev;
	uint32_t block;
};

# Erase NAND block interleaved
#
# Return values:
# 0: Success
#
METHOD int erase_block_intlv {
	device_t dev;
	uint32_t block;
} DEFAULT nand_method_not_supported;

# NAND get status
#
# Return values:
# 0: Success
#
METHOD int get_status {
	device_t dev;
	uint8_t *status;
};

# NAND check if block is bad
#
# Return values:
# 0: Success
#
METHOD int is_blk_bad {
	device_t dev;
	uint32_t block_number;
	uint8_t  *bad;
};

# NAND get ECC
#
#
METHOD int get_ecc {
	device_t dev;
	void *buf;
	void *ecc;
	int *needwrite;
};

# NAND correct ECC
#
#
METHOD int correct_ecc {
	device_t dev;
	void *buf;
	void *readecc;
	void *calcecc;
};