Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
npcx_flash_api_ex.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2023 Nuvoton Technology Corporation.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
12
13#ifndef __ZEPHYR_INCLUDE_DRIVERS_NPCX_FLASH_API_EX_H__
14#define __ZEPHYR_INCLUDE_DRIVERS_NPCX_FLASH_API_EX_H__
15
22
23#ifdef __cplusplus
24extern "C" {
25#endif
26
28
77
91
100
110
119
130
135#define NPCX_EX_OP_LOCK_UMA BIT(0)
136#define NPCX_EX_OP_INT_FLASH_WP BIT(1)
138
139#ifdef __cplusplus
140}
141#endif
142
146
147#endif /* __ZEPHYR_INCLUDE_DRIVERS_NPCX_FLASH_API_EX_H__ */
Main header file for Flash driver API.
#define FLASH_EX_OP_VENDOR_BASE
Definition flash.h:735
flash_npcx_ex_ops
Enumeration for NPCX flash extended operations.
Definition npcx_flash_api_ex.h:32
@ FLASH_NPCX_EX_OP_GET_QSPI_OPER
Get specific operation for Quad-SPI nor flash.
Definition npcx_flash_api_ex.h:66
@ FLASH_NPCX_EX_OP_SET_QSPI_OPER
Configure specific operation for Quad-SPI nor flash.
Definition npcx_flash_api_ex.h:57
@ FLASH_NPCX_EX_OP_EXEC_UMA
User Mode Access (UMA) mode execution.
Definition npcx_flash_api_ex.h:46
@ FLASH_NPCX_EX_OP_EXEC_GDMA
NPCX General DMA (GDMA) mode execution.
Definition npcx_flash_api_ex.h:75
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINT16_TYPE__ uint16_t
Definition stdint.h:89
Input parameters for FLASH_NPCX_EX_OP_EXEC_GDMA operation.
Definition npcx_flash_api_ex.h:125
uint32_t src
Source address of the transfer.
Definition npcx_flash_api_ex.h:126
uint16_t length
Number of bytes to transfer.
Definition npcx_flash_api_ex.h:128
uint32_t dst
Destination address of the transfer.
Definition npcx_flash_api_ex.h:127
Input parameters for FLASH_NPCX_EX_OP_SET_QSPI_OPER operation.
Definition npcx_flash_api_ex.h:106
uint32_t mask
Mask of operations to configure.
Definition npcx_flash_api_ex.h:108
bool enable
True to enable, false to disable.
Definition npcx_flash_api_ex.h:107
Output parameters for FLASH_NPCX_EX_OP_GET_QSPI_OPER operation.
Definition npcx_flash_api_ex.h:116
uint32_t oper
Bitfield of currently active operations.
Definition npcx_flash_api_ex.h:117
Input parameters for FLASH_NPCX_EX_OP_EXEC_UMA operation.
Definition npcx_flash_api_ex.h:83
size_t addr_count
Number of address bytes (0–4).
Definition npcx_flash_api_ex.h:88
uint32_t addr
Address for address phase.
Definition npcx_flash_api_ex.h:87
uint8_t * tx_buf
Pointer to transmit buffer (may be NULL).
Definition npcx_flash_api_ex.h:85
size_t rx_count
Number of bytes expected to be read.
Definition npcx_flash_api_ex.h:89
uint8_t opcode
SPI opcode (command byte).
Definition npcx_flash_api_ex.h:84
size_t tx_count
Number of bytes to transmit.
Definition npcx_flash_api_ex.h:86
Output parameters for FLASH_NPCX_EX_OP_EXEC_UMA operation.
Definition npcx_flash_api_ex.h:97
uint8_t * rx_buf
Pointer to receive buffer (must be large enough).
Definition npcx_flash_api_ex.h:98