xref: /freebsd/sys/dev/flash/qspi_if.m (revision 2008043f386721d58158e37e0d7e50df8095942d)
1#-
2# Copyright (c) 2017-2018 Ruslan Bukin <br@bsdpad.com>
3# All rights reserved.
4#
5# This software was developed by SRI International and the University of
6# Cambridge Computer Laboratory under DARPA/AFRL contract FA8750-10-C-0237
7# ("CTSRD"), as part of the DARPA CRASH research programme.
8#
9# Redistribution and use in source and binary forms, with or without
10# modification, are permitted provided that the following conditions
11# are met:
12# 1. Redistributions of source code must retain the above copyright
13#    notice, this list of conditions and the following disclaimer.
14# 2. Redistributions in binary form must reproduce the above copyright
15#    notice, this list of conditions and the following disclaimer in the
16#    documentation and/or other materials provided with the distribution.
17#
18# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28# SUCH DAMAGE.
29#
30#
31
32#include <sys/bus.h>
33#include <sys/bio.h>
34
35INTERFACE qspi;
36
37METHOD int read {
38	device_t dev;
39	device_t child;
40	struct bio *bp;
41	off_t offset;
42	caddr_t data;
43	off_t count;
44};
45
46METHOD int write {
47	device_t dev;
48	device_t child;
49	struct bio *bp;
50	off_t offset;
51	caddr_t data;
52	off_t count;
53};
54
55METHOD int erase {
56	device_t dev;
57	device_t child;
58	off_t offset;
59};
60
61METHOD int write_reg {
62	device_t dev;
63	device_t child;
64	uint8_t opcode;
65	uint8_t *addr;
66	uint32_t len;
67};
68
69METHOD int read_reg {
70	device_t dev;
71	device_t child;
72	uint8_t opcode;
73	uint8_t *addr;
74	uint32_t len;
75};
76