e5b280f173
A new method of workaround an error with DPORT is to ensure that the APB is read and followed by the DPORT register without interruptions and pauses. This fix places this implementation in the IRAM to exclude errors associated with the cache miss.
202 lines
8.6 KiB
C
202 lines
8.6 KiB
C
// Copyright 2010-2017 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 _DPORT_ACCESS_H_
|
|
#define _DPORT_ACCESS_H_
|
|
|
|
#include <stdint.h>
|
|
#include "esp_attr.h"
|
|
#include "esp_dport_access.h"
|
|
#include "soc.h"
|
|
#include "uart_reg.h"
|
|
#include "xtensa/xtruntime.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
//Registers Operation {{
|
|
|
|
// The _DPORT_xxx register read macros access DPORT memory directly (as opposed to
|
|
// DPORT_REG_READ which applies SMP-safe protections).
|
|
//
|
|
// There are several ways to read the DPORT registers:
|
|
// 1) Use DPORT_REG_READ versions to be SMP-safe in IDF apps.
|
|
// This method uses the pre-read APB implementation(*) without stall other CPU.
|
|
// This is beneficial for single readings.
|
|
// 2) If you want to make a sequence of DPORT reads to buffer,
|
|
// use dport_read_buffer(buff_out, address, num_words),
|
|
// it is the faster method and it doesn't stop other CPU.
|
|
// 3) If you want to make a sequence of DPORT reads, but you don't want to stop other CPU
|
|
// and you want to do it faster then you need use DPORT_SEQUENCE_REG_READ().
|
|
// The difference from the first is that the user himself must disable interrupts while DPORT reading.
|
|
// Note that disable interrupt need only if the chip has two cores.
|
|
// 4) If you want to make a sequence of DPORT reads,
|
|
// use DPORT_STALL_OTHER_CPU_START() macro explicitly
|
|
// and then use _DPORT_REG_READ macro while other CPU is stalled.
|
|
// After completing read operations, use DPORT_STALL_OTHER_CPU_END().
|
|
// This method uses stall other CPU while reading DPORT registers.
|
|
// Useful for compatibility, as well as for large consecutive readings.
|
|
// This method is slower, but must be used if ROM functions or
|
|
// other code is called which accesses DPORT without any other workaround.
|
|
// *) The pre-readable APB register before reading the DPORT register
|
|
// helps synchronize the operation of the two CPUs,
|
|
// so that reading on different CPUs no longer causes random errors APB register.
|
|
|
|
// _DPORT_REG_WRITE & DPORT_REG_WRITE are equivalent.
|
|
#define _DPORT_REG_READ(_r) (*(volatile uint32_t *)(_r))
|
|
#define _DPORT_REG_WRITE(_r, _v) (*(volatile uint32_t *)(_r)) = (_v)
|
|
|
|
// Write value to DPORT register (does not require protecting)
|
|
#define DPORT_REG_WRITE(_r, _v) _DPORT_REG_WRITE((_r), (_v))
|
|
|
|
/**
|
|
* @brief Read value from register, SMP-safe version.
|
|
*
|
|
* This method uses the pre-reading of the APB register before reading the register of the DPORT.
|
|
* This implementation is useful for reading DORT registers for single reading without stall other CPU.
|
|
* There is disable/enable interrupt.
|
|
*
|
|
* @param reg Register address
|
|
* @return Value
|
|
*/
|
|
static inline uint32_t IRAM_ATTR DPORT_REG_READ(uint32_t reg)
|
|
{
|
|
#if defined(BOOTLOADER_BUILD) || defined(CONFIG_FREERTOS_UNICORE) || !defined(ESP_PLATFORM)
|
|
return _DPORT_REG_READ(reg);
|
|
#else
|
|
return esp_dport_access_reg_read(reg);
|
|
#endif
|
|
}
|
|
|
|
/**
|
|
* @brief Read value from register, NOT SMP-safe version.
|
|
*
|
|
* This method uses the pre-reading of the APB register before reading the register of the DPORT.
|
|
* There is not disable/enable interrupt.
|
|
* The difference from DPORT_REG_READ() is that the user himself must disable interrupts while DPORT reading.
|
|
* This implementation is useful for reading DORT registers in loop without stall other CPU. Note the usage example.
|
|
* The recommended way to read registers sequentially without stall other CPU
|
|
* is to use the method esp_dport_read_buffer(buff_out, address, num_words). It allows you to read registers in the buffer.
|
|
*
|
|
* \code{c}
|
|
* // This example shows how to use it.
|
|
* { // Use curly brackets to limit the visibility of variables in macros DPORT_INTERRUPT_DISABLE/RESTORE.
|
|
* DPORT_INTERRUPT_DISABLE(); // Disable interrupt only on current CPU.
|
|
* for (i = 0; i < max; ++i) {
|
|
* array[i] = DPORT_SEQUENCE_REG_READ(Address + i * 4); // reading DPORT registers
|
|
* }
|
|
* DPORT_INTERRUPT_RESTORE(); // restore the previous interrupt level
|
|
* }
|
|
* \endcode
|
|
*
|
|
* @param reg Register address
|
|
* @return Value
|
|
*/
|
|
static inline uint32_t IRAM_ATTR DPORT_SEQUENCE_REG_READ(uint32_t reg)
|
|
{
|
|
#if defined(BOOTLOADER_BUILD) || defined(CONFIG_FREERTOS_UNICORE) || !defined(ESP_PLATFORM)
|
|
return _DPORT_REG_READ(reg);
|
|
#else
|
|
return esp_dport_access_sequence_reg_read(reg);
|
|
#endif
|
|
}
|
|
|
|
//get bit or get bits from register
|
|
#define DPORT_REG_GET_BIT(_r, _b) (DPORT_REG_READ(_r) & (_b))
|
|
|
|
//set bit or set bits to register
|
|
#define DPORT_REG_SET_BIT(_r, _b) DPORT_REG_WRITE((_r), (DPORT_REG_READ(_r)|(_b)))
|
|
|
|
//clear bit or clear bits of register
|
|
#define DPORT_REG_CLR_BIT(_r, _b) DPORT_REG_WRITE((_r), (DPORT_REG_READ(_r) & (~(_b))))
|
|
|
|
//set bits of register controlled by mask
|
|
#define DPORT_REG_SET_BITS(_r, _b, _m) DPORT_REG_WRITE((_r), ((DPORT_REG_READ(_r) & (~(_m))) | ((_b) & (_m))))
|
|
|
|
//get field from register, uses field _S & _V to determine mask
|
|
#define DPORT_REG_GET_FIELD(_r, _f) ((DPORT_REG_READ(_r) >> (_f##_S)) & (_f##_V))
|
|
|
|
//set field to register, used when _f is not left shifted by _f##_S
|
|
#define DPORT_REG_SET_FIELD(_r, _f, _v) DPORT_REG_WRITE((_r), ((DPORT_REG_READ(_r) & (~((_f##_V) << (_f##_S))))|(((_v) & (_f##_V))<<(_f##_S))))
|
|
|
|
//get field value from a variable, used when _f is not left shifted by _f##_S
|
|
#define DPORT_VALUE_GET_FIELD(_r, _f) (((_r) >> (_f##_S)) & (_f))
|
|
|
|
//get field value from a variable, used when _f is left shifted by _f##_S
|
|
#define DPORT_VALUE_GET_FIELD2(_r, _f) (((_r) & (_f))>> (_f##_S))
|
|
|
|
//set field value to a variable, used when _f is not left shifted by _f##_S
|
|
#define DPORT_VALUE_SET_FIELD(_r, _f, _v) ((_r)=(((_r) & ~((_f) << (_f##_S)))|((_v)<<(_f##_S))))
|
|
|
|
//set field value to a variable, used when _f is left shifted by _f##_S
|
|
#define DPORT_VALUE_SET_FIELD2(_r, _f, _v) ((_r)=(((_r) & ~(_f))|((_v)<<(_f##_S))))
|
|
|
|
//generate a value from a field value, used when _f is not left shifted by _f##_S
|
|
#define DPORT_FIELD_TO_VALUE(_f, _v) (((_v)&(_f))<<_f##_S)
|
|
|
|
//generate a value from a field value, used when _f is left shifted by _f##_S
|
|
#define DPORT_FIELD_TO_VALUE2(_f, _v) (((_v)<<_f##_S) & (_f))
|
|
|
|
//Register read macros with an underscore prefix access DPORT memory directly. In IDF apps, use the non-underscore versions to be SMP-safe.
|
|
#define _DPORT_READ_PERI_REG(addr) (*((volatile uint32_t *)(addr)))
|
|
#define _DPORT_WRITE_PERI_REG(addr, val) (*((volatile uint32_t *)(addr))) = (uint32_t)(val)
|
|
#define _DPORT_REG_SET_BIT(_r, _b) _DPORT_REG_WRITE((_r), (_DPORT_REG_READ(_r)|(_b)))
|
|
#define _DPORT_REG_CLR_BIT(_r, _b) _DPORT_REG_WRITE((_r), (_DPORT_REG_READ(_r) & (~(_b))))
|
|
|
|
/**
|
|
* @brief Read value from register, SMP-safe version.
|
|
*
|
|
* This method uses the pre-reading of the APB register before reading the register of the DPORT.
|
|
* This implementation is useful for reading DORT registers for single reading without stall other CPU.
|
|
*
|
|
* @param reg Register address
|
|
* @return Value
|
|
*/
|
|
static inline uint32_t IRAM_ATTR DPORT_READ_PERI_REG(uint32_t reg)
|
|
{
|
|
#if defined(BOOTLOADER_BUILD) || defined(CONFIG_FREERTOS_UNICORE) || !defined(ESP_PLATFORM)
|
|
return _DPORT_REG_READ(reg);
|
|
#else
|
|
return esp_dport_access_reg_read(reg);
|
|
#endif
|
|
}
|
|
|
|
//write value to register
|
|
#define DPORT_WRITE_PERI_REG(addr, val) _DPORT_WRITE_PERI_REG((addr), (val))
|
|
|
|
//clear bits of register controlled by mask
|
|
#define DPORT_CLEAR_PERI_REG_MASK(reg, mask) DPORT_WRITE_PERI_REG((reg), (DPORT_READ_PERI_REG(reg)&(~(mask))))
|
|
|
|
//set bits of register controlled by mask
|
|
#define DPORT_SET_PERI_REG_MASK(reg, mask) DPORT_WRITE_PERI_REG((reg), (DPORT_READ_PERI_REG(reg)|(mask)))
|
|
|
|
//get bits of register controlled by mask
|
|
#define DPORT_GET_PERI_REG_MASK(reg, mask) (DPORT_READ_PERI_REG(reg) & (mask))
|
|
|
|
//get bits of register controlled by highest bit and lowest bit
|
|
#define DPORT_GET_PERI_REG_BITS(reg, hipos,lowpos) ((DPORT_READ_PERI_REG(reg)>>(lowpos))&((1<<((hipos)-(lowpos)+1))-1))
|
|
|
|
//set bits of register controlled by mask and shift
|
|
#define DPORT_SET_PERI_REG_BITS(reg,bit_map,value,shift) DPORT_WRITE_PERI_REG((reg), ((DPORT_READ_PERI_REG(reg)&(~((bit_map)<<(shift))))|(((value) & bit_map)<<(shift))))
|
|
|
|
//get field of register
|
|
#define DPORT_GET_PERI_REG_BITS2(reg, mask,shift) ((DPORT_READ_PERI_REG(reg)>>(shift))&(mask))
|
|
//}}
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _DPORT_ACCESS_H_ */
|