Zephyr API Documentation 4.4.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches

Extended operations for Microchip G3 flash memory controllers. More...

Files

file  mchp_nvmctrl_g2.h
 Header file supporting ex_op for Microchip flash-controller G2 driver.
 
file  mchp_nvmctrl_g3.h
 Header file supporting ex_op for Microchip flash-controller G3 driver.
 

Data Structures

struct  pfm_exop
 Program Flash Memory (PFM) extended operation parameters. More...
 
struct  bfm_exop
 Boot Flash Memory (BFM) extended operation parameters. More...
 

Enumerations

enum  flash_mchp_ex_ops_t {
  FLASH_EX_OP_REGION_LOCK , FLASH_EX_OP_REGION_UNLOCK , FLASH_EX_OP_SET_PWR_REDUCTION_MODE , FLASH_EX_OP_CLR_PWR_REDUCTION_MODE ,
  FLASH_EX_OP_CLR_PAGE_BUFFER , FLASH_EX_OP_SET_SECURITY_BIT , FLASH_EX_OP_INVALIDATE_CACHE_LINES , FLASH_EX_OP_SET_CHIP_ERASE_HARDLOCK
}
 This enumeration defines the set of extended operations that can be performed on the flash memory, such as erasing or writing the user row, and locking or unlocking specific flash regions. More...
 
enum  flash_mchp_ex_ops_t {
  FLASH_EX_OP_PFM_REGION_WRITE_PROTECT_ENABLE , FLASH_EX_OP_PFM_REGION_WRITE_PROTECT_DISABLE , FLASH_EX_OP_PFM_REGION_WRITE_PROTECT_LOCK , FLASH_EX_OP_BFM_WRITE_PROTECT_ENABLE ,
  FLASH_EX_OP_BFM_WRITE_PROTECT_DISABLE , FLASH_EX_OP_BFM_WRITE_PROTECT_LOCK
}
 This enumeration defines the set of extended operations that can be performed on the flash memory, such as erasing or writing the user row, and locking or unlocking specific flash regions. More...
 
enum  pfm_wp_region {
  PFM_WP_REGION_0 , PFM_WP_REGION_1 , PFM_WP_REGION_2 , PFM_WP_REGION_3 ,
  PFM_WP_REGION_4 , PFM_WP_REGION_5 , PFM_WP_REGION_6 , PFM_WP_REGION_7
}
 Program Flash Memory (PFM) write protection regions. More...
 
enum  boot_flash_bank { BOOT_FLASH_BANK_1 , BOOT_FLASH_BANK_2 }
 Boot Flash Memory (BFM) bank selection. More...
 

Detailed Description

Extended operations for Microchip G3 flash memory controllers.

Since
4.5
Version
0.1.0

Enumeration Type Documentation

◆ boot_flash_bank

#include <zephyr/drivers/flash/mchp_nvmctrl_g3.h>

Boot Flash Memory (BFM) bank selection.

This enumeration defines the available boot flash memory banks/panels. The boot flash memory can be organized into multiple banks for redundancy and fail-safe boot operations.

Enumerator
BOOT_FLASH_BANK_1 

Boot Flash Memory Bank/Panel 1.

BOOT_FLASH_BANK_2 

Boot Flash Memory Bank/Panel 2.

◆ flash_mchp_ex_ops_t [1/2]

#include <zephyr/drivers/flash/mchp_nvmctrl_g2.h>

This enumeration defines the set of extended operations that can be performed on the flash memory, such as erasing or writing the user row, and locking or unlocking specific flash regions.

Enumerator
FLASH_EX_OP_REGION_LOCK 

Lock a specific region.

FLASH_EX_OP_REGION_UNLOCK 

Unlock a specific region.

FLASH_EX_OP_SET_PWR_REDUCTION_MODE 

Sets the Power Reduction mode.

FLASH_EX_OP_CLR_PWR_REDUCTION_MODE 

Clears the Power Reduction mode.

FLASH_EX_OP_CLR_PAGE_BUFFER 

Clears the flash page buffer.

FLASH_EX_OP_SET_SECURITY_BIT 

Set Security Bit.

FLASH_EX_OP_INVALIDATE_CACHE_LINES 

Invalidates all cache lines.

FLASH_EX_OP_SET_CHIP_ERASE_HARDLOCK 

Set Chip Erase Hard Lock.

◆ flash_mchp_ex_ops_t [2/2]

#include <zephyr/drivers/flash/mchp_nvmctrl_g3.h>

This enumeration defines the set of extended operations that can be performed on the flash memory, such as erasing or writing the user row, and locking or unlocking specific flash regions.

Enumerator
FLASH_EX_OP_PFM_REGION_WRITE_PROTECT_ENABLE 

Enable write protection for a PFM region.

FLASH_EX_OP_PFM_REGION_WRITE_PROTECT_DISABLE 

Disable write protection for a PFM region.

FLASH_EX_OP_PFM_REGION_WRITE_PROTECT_LOCK 

Lock write protection settings for a PFM region.

FLASH_EX_OP_BFM_WRITE_PROTECT_ENABLE 

Enable write protection for BFM.

FLASH_EX_OP_BFM_WRITE_PROTECT_DISABLE 

Disable write protection for BFM.

FLASH_EX_OP_BFM_WRITE_PROTECT_LOCK 

Lock write protection settings for BFM.

◆ pfm_wp_region

#include <zephyr/drivers/flash/mchp_nvmctrl_g3.h>

Program Flash Memory (PFM) write protection regions.

This enumeration defines the available write protection regions for the Program Flash Memory. Each region can be independently configured for write protection.

Enumerator
PFM_WP_REGION_0 

PFM write protection region 0.

PFM_WP_REGION_1 

PFM write protection region 1.

PFM_WP_REGION_2 

PFM write protection region 2.

PFM_WP_REGION_3 

PFM write protection region 3.

PFM_WP_REGION_4 

PFM write protection region 4.

PFM_WP_REGION_5 

PFM write protection region 5.

PFM_WP_REGION_6 

PFM write protection region 6.

PFM_WP_REGION_7 

PFM write protection region 7.