nuttx/boards/arm/cxd56xx/spresense/include/board.h
SPRESENSE 1e7f5e8aa8 boards: spresense: Add Power domain definitions
Add power domain definitions for using PM System.
2023-06-14 08:49:19 +02:00

346 lines
10 KiB
C

/****************************************************************************
* boards/arm/cxd56xx/spresense/include/board.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 __BOARDS_ARM_CXD56XX_SPRESENSE_INCLUDE_BOARD_H
#define __BOARDS_ARM_CXD56XX_SPRESENSE_INCLUDE_BOARD_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <nuttx/irq.h>
#include <sys/boardctl.h>
#include <stdbool.h>
#include <arch/chip/pin.h>
#include "board_lcdpins.h"
#include "cxd56_clock.h"
#include "cxd56_power.h"
#include "cxd56_flash.h"
#include "cxd56_gauge.h"
#include "cxd56_charger.h"
#include "cxd56_gs2200m.h"
#include "cxd56_i2cdev.h"
#include "cxd56_spidev.h"
#include "cxd56_sdcard.h"
#include "cxd56_automount.h"
#include "cxd56_wdt.h"
#include "cxd56_gpioif.h"
#include "cxd56_audio.h"
#include "cxd56_alt1250.h"
#include "cxd56_ak09912.h"
#include "cxd56_apds9930.h"
#include "cxd56_apds9960.h"
#include "cxd56_bcm20706.h"
#include "cxd56_bh1721fvc.h"
#include "cxd56_bh1745nuc.h"
#include "cxd56_bm1383glv.h"
#include "cxd56_bm1422gmv.h"
#include "cxd56_bmi160.h"
#include "cxd56_bmp280.h"
#include "cxd56_emmcdev.h"
#include "cxd56_spisd.h"
#include "cxd56_kx022.h"
#include "cxd56_lt1pa01.h"
#include "cxd56_rpr0521rs.h"
#include "cxd56_scd41.h"
#include "cxd56_sensors.h"
#ifdef CONFIG_VIDEO_ISX012
# include "cxd56_isx012.h"
#endif /* CONFIG_VIDEO_ISX012 */
#ifdef CONFIG_VIDEO_ISX019
# include "cxd56_isx019.h"
#endif /* CONFIG_VIDEO_ISX019 */
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* Clocking *****************************************************************/
#ifdef CONFIG_CXD56_80MHz
# define BOARD_FCLKOUT_FREQUENCY (80000000)
#else
# define BOARD_FCLKOUT_FREQUENCY (100000000)
#endif
/* UART clocking ************************************************************/
/* Configure all UARTs to use the XTAL input frequency */
#define BOARD_UART0_BASEFREQ CONFIG_CXD56_XOSC_CLOCK
#define BOARD_UART1_BASEFREQ BOARD_FCLKOUT_FREQUENCY
#define BOARD_UART2_BASEFREQ CONFIG_CXD56_XOSC_CLOCK
/* LED definitions **********************************************************/
#define GPIO_LED1 (PIN_I2S1_BCK)
#define GPIO_LED2 (PIN_I2S1_LRCK)
#define GPIO_LED3 (PIN_I2S1_DATA_IN)
#define GPIO_LED4 (PIN_I2S1_DATA_OUT)
#define BOARD_LED1 (0)
#define BOARD_LED2 (1)
#define BOARD_LED3 (2)
#define BOARD_LED4 (3)
#define BOARD_NLEDS (4)
/* LED bits for use with board_userled_all() */
#define BOARD_LED1_BIT (1 << BOARD_LED1)
#define BOARD_LED2_BIT (1 << BOARD_LED2)
#define BOARD_LED3_BIT (1 << BOARD_LED3)
#define BOARD_LED4_BIT (1 << BOARD_LED4)
/* LED pattern for use with board_autoled_on() and board_autoled_off() */
#define LED_STARTED (BOARD_LED1_BIT)
#define LED_HEAPALLOCATE (BOARD_LED2_BIT)
#define LED_IRQSENABLED (BOARD_LED1_BIT | BOARD_LED2_BIT)
#define LED_STACKCREATED (BOARD_LED3_BIT)
#define LED_INIRQ (BOARD_LED1_BIT | BOARD_LED3_BIT)
#define LED_SIGNAL (BOARD_LED2_BIT | BOARD_LED3_BIT)
#define LED_ASSERTION (BOARD_LED1_BIT | BOARD_LED2_BIT | BOARD_LED3_BIT)
#define LED_PANIC (BOARD_LED4_BIT)
#ifdef CONFIG_ARCH_LEDS_CPU_ACTIVITY
/* NOTE: LED_CPUx is not a bit pattern but just a number which
* does not conflict with existing LED bit patterns
*/
#define LED_CPU0 (100)
#define LED_CPU1 (101)
#define LED_CPU2 (102)
#define LED_CPU3 (103)
#define LED_CPU (LED_CPU0 + up_cpu_index())
#endif
/* Buttons definitions ******************************************************/
#define BOARD_NUM_BUTTONS (2)
/* Power Control definitions ************************************************/
/* For SPRESENSE board:
*
* Switch Device
* --------- -------------------------------
* LDO_EMMC GNSS A-ANT
* DDC_ANA N/A
* LDO_PERI N/A
* LSW2 CXD5247 Audio Digital VDD
* LSW3 SPI-Flash
* LSW4 TCXO & GNSS LNA
* GPO0
* GPO1 CXD5247 Audio Analog VDD
* GPO2
* GPO3
* GPO4 Camera
* GPO5 Camera
* GPO6 Audio External Amp.
* GPO7 Camera
*
*/
#define PMIC_NONE (0)
#define PMIC_TYPE_LSW (1u << 8)
#define PMIC_TYPE_GPO (1u << 9)
#define PMIC_TYPE_DDCLDO (1u << 10)
#define CHIP_TYPE_GPIO (1u << 11)
#define PMIC_GET_TYPE(v) ((v) & 0xff00)
#define PMIC_GET_CH(v) ((v) & 0x00ff)
#define PMIC_LSW(n) (PMIC_TYPE_LSW | (1u << (n)))
#define PMIC_GPO(n) (PMIC_TYPE_GPO | (1u << (n)))
#define PMIC_DDCLDO(n) (PMIC_TYPE_DDCLDO | (1u << (n)))
#define CHIP_GPIO(n) (CHIP_TYPE_GPIO | (n))
enum board_power_device
{
/* DDC/LDO */
POWER_DDC_IO = PMIC_DDCLDO(0),
POWER_LDO_EMMC = PMIC_DDCLDO(1),
POWER_DDC_ANA = PMIC_DDCLDO(2),
POWER_LDO_ANA = PMIC_DDCLDO(3),
POWER_DDC_CORE = PMIC_DDCLDO(4),
POWER_LDO_PERI = PMIC_DDCLDO(5),
/* Load Switch */
POWER_AUDIO_DVDD = PMIC_LSW(2),
POWER_FLASH = PMIC_LSW(3),
POWER_TCXO = PMIC_LSW(4),
POWER_LNA = PMIC_LSW(4),
/* GPO */
POWER_AUDIO_AVDD = PMIC_GPO(1),
POWER_AUDIO_MUTE = PMIC_GPO(6),
POWER_IMAGE_SENSOR = PMIC_GPO(4),
POWER_BTBLE = PMIC_NONE,
POWER_SENSOR = PMIC_NONE,
#if defined(CONFIG_CXD56_EMMC_POWER_PIN_I2S0_BCK)
POWER_EMMC = CHIP_GPIO(PIN_I2S0_BCK),
#elif defined(CONFIG_CXD56_EMMC_POWER_PIN_UART2_CTS)
POWER_EMMC = CHIP_GPIO(PIN_UART2_CTS),
#else
POWER_EMMC = PMIC_NONE,
#endif
POWER_LTE = PMIC_GPO(2),
};
/* Power Off Level definitions **********************************************/
#define BOARD_POWEROFF_DEEP (0)
#define BOARD_POWEROFF_COLD (1)
/* Power domain definitions *************************************************/
#define BOARD_PM_IDLE (0)
#define BOARD_PM_APPS (1)
/* CXD5247 audio control definitions ****************************************/
#define CXD5247_XRST PIN_SPI3_CS2_X
#define CXD5247_AVDD (0x01)
#define CXD5247_DVDD (0x02)
/* LCD Display clocking *****************************************************/
#define ILI9340_SPI_MAXFREQUENCY 40000000
/* Display device pin definitions *******************************************/
#if defined(CONFIG_LCD_ON_MAIN_BOARD) /* Display connected to main board. */
#define DISPLAY_SPI 5
#define DISPLAY_DMA_TXCH (4)
#define DISPLAY_DMA_RXCH (5)
#define DISPLAY_DMA_TXCH_CFG CXD56_DMA_PERIPHERAL_SPI5_TX
#define DISPLAY_DMA_RXCH_CFG CXD56_DMA_PERIPHERAL_SPI5_RX
#define DISPLAY_DMA_TX_MAXSIZE (192000)
#define DISPLAY_DMA_RX_MAXSIZE (192000)
#elif defined(CONFIG_LCD_ON_LTE_EXTENSION_BOARD)
/* Display connected to LTE extension board. */
#define DISPLAY_SPI 3
/* Specify invalid channels because DMA cannot be used */
#define DISPLAY_DMA_TXCH (-1)
#define DISPLAY_DMA_RXCH (-1)
#define DISPLAY_DMA_TXCH_CFG (-1)
#define DISPLAY_DMA_RXCH_CFG (-1)
#define DISPLAY_DMA_TX_MAXSIZE (192000)
#define DISPLAY_DMA_RX_MAXSIZE (192000)
#else /* Display is connected through extension board. */
#define DISPLAY_SPI 4
#define DISPLAY_DMA_TXCH (2)
#define DISPLAY_DMA_RXCH (3)
#define DISPLAY_DMA_TXCH_CFG CXD56_DMA_PERIPHERAL_SPI4_TX
#define DISPLAY_DMA_RXCH_CFG CXD56_DMA_PERIPHERAL_SPI4_RX
#define DISPLAY_DMA_TX_MAXSIZE (192000)
#define DISPLAY_DMA_RX_MAXSIZE (192000)
#endif
#define DISPLAY_RST ILI934X_RST_PIN
#define DISPLAY_DC ILI934X_DC_PIN
/* Sensor device bus definitions ********************************************/
#define SENSOR_I2C 0
#define SENSOR_SPI 3
/* Imager device pin definitions ********************************************/
#define IMAGER_RST PIN_SDIO_DIR1_3
#define IMAGER_SLEEP PIN_SDIO_DIR0
#define IMAGER_I2C 2
/* Set signal id for notify USB device connection status and
* supply current value.
* signal returns "usbdev_notify_s" struct pointer in sival_ptr.
*
* Arg: Value of sinal number
*/
#define BOARDIOC_USBDEV_SETNOTIFYSIG (BOARDIOC_USER+0x0001)
/* Altair modem device pin definitions **************************************/
#define ALT1250_SLAVE_REQ PIN_SPI2_SCK
#define ALT1250_MASTER_REQ PIN_RTC_IRQ_OUT
#define ALT1250_WAKEUP PIN_SPI2_MOSI
#define ALT1250_SHUTDOWN PIN_SPI2_MISO
#define ALT1250_LTE_POWER_BUTTON PIN_AP_CLK
/****************************************************************************
* Public Types
****************************************************************************/
#ifndef __ASSEMBLY__
/****************************************************************************
* Public Data
****************************************************************************/
#undef EXTERN
#if defined(__cplusplus)
#define EXTERN extern "C"
extern "C"
{
#else
#define EXTERN extern
#endif
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
/****************************************************************************
* Name: cxd56_boardinitialize
*
* Description:
*
****************************************************************************/
void cxd56_boardinitialize(void);
#undef EXTERN
#if defined(__cplusplus)
}
#endif
#endif /* __ASSEMBLY__ */
#endif /* __BOARDS_ARM_CXD56XX_SPRESENSE_INCLUDE_BOARD_H */