mirror of
				https://github.com/espressif/esp-idf.git
				synced 2025-11-03 08:31:44 +01:00 
			
		
		
		
	1. Add reading psram EID. 2. Configure different clock mode for different EID. 3. add API to get psram size and voltage. 4. Remove unnecessary VSPI claim. For 32MBit@1.8V and 64MBit@3.3V psram, there should be 2 extra clock cycles after CS get high level. For 64MBit@1.8 psram, we can just use standard SPI protocol to drive the psram. We also need to increase the HOLD time for CS in this case. EID for psram: 32MBit 1.8v: 0x20 64MBit 1.8v: 0x26 64MBit 3.3v: 0x46
		
			
				
	
	
		
			84 lines
		
	
	
		
			2.5 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			84 lines
		
	
	
		
			2.5 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
 | 
						|
//
 | 
						|
// 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.
 | 
						|
 | 
						|
 | 
						|
#ifndef _PSRAM_H
 | 
						|
#define _PSRAM_H
 | 
						|
#include "soc/spi_reg.h"
 | 
						|
#include "esp_err.h"
 | 
						|
#include "sdkconfig.h"
 | 
						|
 | 
						|
typedef enum {
 | 
						|
    PSRAM_CACHE_F80M_S40M = 0,
 | 
						|
    PSRAM_CACHE_F40M_S40M,
 | 
						|
    PSRAM_CACHE_F80M_S80M,
 | 
						|
    PSRAM_CACHE_MAX,
 | 
						|
} psram_cache_mode_t;
 | 
						|
 | 
						|
typedef enum {
 | 
						|
    PSRAM_VOLT_3V3 = 0,
 | 
						|
    PSRAM_VOLT_1V8 = 1,
 | 
						|
    PSRAM_VOLT_MAX,
 | 
						|
} psram_volt_t;
 | 
						|
 | 
						|
typedef enum {
 | 
						|
    PSRAM_SIZE_32MBITS = 0,
 | 
						|
    PSRAM_SIZE_64MBITS = 1,
 | 
						|
    PSRAM_SIZE_MAX,
 | 
						|
} psram_size_t;
 | 
						|
 | 
						|
/*
 | 
						|
See the TRM, chapter PID/MPU/MMU, header 'External RAM' for the definitions of these modes.
 | 
						|
 | 
						|
Important is that NORMAL works with the app CPU cache disabled, but gives huge cache coherency
 | 
						|
issues when both app and pro CPU are enabled. LOWHIGH and EVENODD do not have these coherency
 | 
						|
issues but cannot be used when the app CPU cache is disabled.
 | 
						|
*/
 | 
						|
 | 
						|
typedef enum {
 | 
						|
    PSRAM_VADDR_MODE_NORMAL=0, ///< App and pro CPU use their own flash cache for external RAM access
 | 
						|
    PSRAM_VADDR_MODE_LOWHIGH,  ///< App and pro CPU share external RAM caches: pro CPU has low 2M, app CPU has high 2M
 | 
						|
    PSRAM_VADDR_MODE_EVENODD,  ///< App and pro CPU share external RAM caches: pro CPU does even 32yte ranges, app does odd ones.
 | 
						|
} psram_vaddr_mode_t;
 | 
						|
 | 
						|
/**
 | 
						|
 * @brief get psram voltage
 | 
						|
 * @return
 | 
						|
 *     - PSRAM_VOLT_MAX if psram not enabled or not valid.
 | 
						|
 *     - PSRAM voltage
 | 
						|
 */
 | 
						|
psram_volt_t psram_get_volt();
 | 
						|
 | 
						|
/**
 | 
						|
 * @brief get psram size
 | 
						|
 * @return
 | 
						|
 *     - PSRAM_SIZE_MAX if psram not enabled or not valid
 | 
						|
 *     - PSRAM size
 | 
						|
 */
 | 
						|
psram_size_t psram_get_size();
 | 
						|
 | 
						|
/**
 | 
						|
 * @brief psram cache enable function
 | 
						|
 *
 | 
						|
 * Esp-idf uses this to initialize cache for psram, mapping it into the main memory
 | 
						|
 * address space.
 | 
						|
 *
 | 
						|
 * @param mode       SPI mode to access psram in
 | 
						|
 * @param vaddrmode  Mode the psram cache works in.
 | 
						|
 * @return ESP_OK on success, ESP_ERR_INVALID_STATE when VSPI peripheral is needed but cannot be claimed.
 | 
						|
 */
 | 
						|
esp_err_t psram_enable(psram_cache_mode_t mode, psram_vaddr_mode_t vaddrmode);
 | 
						|
 | 
						|
#endif
 |