arch/xtensa/src/esp32/esp32_qencoder.h

/****************************************************************************
 * arch/xtensa/src/esp32/esp32_qencoder.h
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.  The
 * ASF licenses this file to you 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 __ARCH_XTENSA_SRC_ESP32_ESP32_QENCODER_H
#define __ARCH_XTENSA_SRC_ESP32_ESP32_QENCODER_H

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include <nuttx/config.h>

#include "chip.h"

#ifdef CONFIG_SENSORS_QENCODER

/****************************************************************************
 * Included Files
 ****************************************************************************/

/* Timer devices may be used for different purposes.  One special purpose is
 * as a quadrature encoder input device.  If CONFIG_ESP32_PCNT_Un is defined
 * then the CONFIG_ESP32_PCNT_Un_QE must also be defined to indicate that
 * pcnt "n" is intended to be used for as a quadrature encoder.
 */

#ifndef CONFIG_ESP32_PCNT_U0
#  undef CONFIG_ESP32_PCNT_U0_QE
#endif
#ifndef CONFIG_ESP32_PCNT_U1
#  undef CONFIG_ESP32_PCNT_U1_QE
#endif
#ifndef CONFIG_ESP32_PCNT_U2
#  undef CONFIG_ESP32_PCNT_U2_QE
#endif
#ifndef CONFIG_ESP32_PCNT_U3
#  undef CONFIG_ESP32_PCNT_U3_QE
#endif
#ifndef CONFIG_ESP32_PCNT_U4
#  undef CONFIG_ESP32_PCNT_U4_QE
#endif
#ifndef CONFIG_ESP32_PCNT_U5
#  undef CONFIG_ESP32_PCNT_U5_QE
#endif
#ifndef CONFIG_ESP32_PCNT_U6
#  undef CONFIG_ESP32_PCNT_U6_QE
#endif
#ifndef CONFIG_ESP32_PCNT_U7
#  undef CONFIG_ESP32_PCNT_U7_QE
#endif

/****************************************************************************
 * Included Files
 ****************************************************************************/

/****************************************************************************
 * Name: esp32_qeinitialize
 *
 * Description:
 *   Initialize a quadrature encoder interface.  This function must be called
 *   from board-specific logic..
 *
 * Input Parameters:
 *   devpath - The full path to the driver to register. E.g., "/dev/qe0"
 *   pcnt    - The PCNT number to used.  'tim' must be an element of
 *             {0,1,2,3,4,5,6,7}
 *
 * Returned Value:
 *   Zero on success; A negated errno value is returned on failure.
 *
 ****************************************************************************/

int esp32_qeinitialize(const char *devpath, int pcnt);

#ifdef CONFIG_ESP32_QENCODER_INDEX_PIN
/****************************************************************************
 * Name: esp32_qe_index_init
 *
 * Description:
 *   Register the encoder index pin to a given Qencoder timer
 *
 * Input Parameters:
 *   pcnt  - The qencoder PCNT number
 *   gpio - gpio pin configuration
 *
 * Returned Value:
 *   Zero on success; A negated errno value is returned on failure.
 *
 ****************************************************************************/

int esp32_qe_index_init(int pcnt, uint32_t gpio);
#endif

#endif /* CONFIG_SENSORS_QENCODER */
#endif /* __ARCH_XTENSA_SRC_ESP32_ESP32_QENCODER_H */