/
qspi_psram.h
125 lines (110 loc) · 2.58 KB
/
qspi_psram.h
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
// Copyright 2020-2021 Beken
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#pragma once
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Init the QSPI psram
*
* @return
* - BK_OK: succeed
* - BK_ERR_QSPI_NOT_INIT: QSPI driver not init
* - others: other errors.
*/
bk_err_t bk_qspi_psram_init(void);
/**
* @brief Deinit the QSPI psram
*
* @return
* - BK_OK: succeed
* - BK_ERR_QSPI_NOT_INIT: QSPI driver not init
* - others: other errors.
*/
bk_err_t bk_qspi_psram_deinit(void);
/**
* @brief QSPI psram enter quad mode
*
* @return
* - BK_OK: succeed
* - others: other errors.
*/
bk_err_t bk_qspi_psram_enter_quad_mode(void);
/**
* @brief QSPI psram exit quad mode
*
* @return
* - BK_OK: succeed
* - others: other errors.
*/
bk_err_t bk_qspi_psram_exit_quad_mode(void);
/**
* @brief QSPI psram init quad write
*
* @return
* - BK_OK: succeed
* - others: other errors.
*/
bk_err_t bk_qspi_psram_quad_write(void);
/**
* @brief QSPI psram init single write
*
* @return
* - BK_OK: succeed
* - others: other errors.
*/
bk_err_t bk_qspi_psram_single_write(void);
/**
* @brief QSPI psram init quad read
*
* @return
* - BK_OK: succeed
* - others: other errors.
*/
bk_err_t bk_qspi_psram_quad_read(void);
/**
* @brief QSPI psram init single read
*
* @return
* - BK_OK: succeed
* - others: other errors.
*/
bk_err_t bk_qspi_psram_single_read(void);
/**
* @brief QSPI psram write data
*
* @param base_addr QSPI write address
* @param data QSPI write data
* @param size the size of QSPI write data
*
* @return
* - BK_OK: succeed
* - others: other errors.
*/
bk_err_t bk_qspi_psram_write(uint32_t base_addr, const void *data, uint32_t size);
/**
* @brief QSPI psram read data
*
* @param base_addr QSPI read address
* @param data QSPI read data
* @param size the size of QSPI read data
*
* @return
* - BK_OK: succeed
* - others: other errors.
*/
bk_err_t bk_qspi_psram_read(uint32_t base_addr, void *data, uint32_t size);
#ifdef __cplusplus
}
#endif