1 /*
2  * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD
3  *
4  * SPDX-License-Identifier: Apache-2.0
5  */
6 
7 #include <bootutil/bootutil_log.h>
8 
9 #include <esp_rom_uart.h>
10 #include <esp_rom_gpio.h>
11 #include <esp_rom_sys.h>
12 #include <esp_rom_caps.h>
13 #include <soc/uart_periph.h>
14 #include <soc/gpio_struct.h>
15 #include <soc/io_mux_reg.h>
16 #include <soc/rtc.h>
17 #include <hal/gpio_types.h>
18 #include <hal/gpio_ll.h>
19 #include <hal/uart_ll.h>
20 #include <hal/clk_gate_ll.h>
21 #include <hal/usb_serial_jtag_ll.h>
22 #include <hal/gpio_hal.h>
23 
24 #ifdef CONFIG_ESP_SERIAL_BOOT_GPIO_DETECT
25 #define SERIAL_BOOT_GPIO_DETECT     CONFIG_ESP_SERIAL_BOOT_GPIO_DETECT
26 #else
27 #define SERIAL_BOOT_GPIO_DETECT     GPIO_NUM_3
28 #endif
29 
30 #ifdef CONFIG_ESP_SERIAL_BOOT_GPIO_DETECT_VAL
31 #define SERIAL_BOOT_GPIO_DETECT_VAL     CONFIG_ESP_SERIAL_BOOT_GPIO_DETECT_VAL
32 #else
33 #define SERIAL_BOOT_GPIO_DETECT_VAL     1
34 #endif
35 
36 #ifdef CONFIG_ESP_SERIAL_BOOT_DETECT_DELAY_S
37 #define SERIAL_BOOT_DETECT_DELAY_S     CONFIG_ESP_SERIAL_BOOT_DETECT_DELAY_S
38 #else
39 #define SERIAL_BOOT_DETECT_DELAY_S     5
40 #endif
41 
42 #ifdef CONFIG_ESP_SERIAL_BOOT_GPIO_INPUT_TYPE
43 #define SERIAL_BOOT_GPIO_INPUT_TYPE    CONFIG_ESP_SERIAL_BOOT_GPIO_INPUT_TYPE
44 #else
45 // pull-down
46 #define SERIAL_BOOT_GPIO_INPUT_TYPE    0
47 #endif
48 
49 #ifndef CONFIG_ESP_MCUBOOT_SERIAL_USB_SERIAL_JTAG
50 
51 #ifdef CONFIG_ESP_SERIAL_BOOT_UART_NUM
52 #define SERIAL_BOOT_UART_NUM    CONFIG_ESP_SERIAL_BOOT_UART_NUM
53 #else
54 #define SERIAL_BOOT_UART_NUM    ESP_ROM_UART_1
55 #endif
56 
57 #ifdef CONFIG_ESP_SERIAL_BOOT_GPIO_RX
58 #define SERIAL_BOOT_GPIO_RX     CONFIG_ESP_SERIAL_BOOT_GPIO_RX
59 #else
60 #define SERIAL_BOOT_GPIO_RX     GPIO_NUM_10
61 #endif
62 
63 #ifdef CONFIG_ESP_SERIAL_BOOT_GPIO_TX
64 #define SERIAL_BOOT_GPIO_TX     CONFIG_ESP_SERIAL_BOOT_GPIO_TX
65 #else
66 #define SERIAL_BOOT_GPIO_TX     GPIO_NUM_11
67 #endif
68 
69 static uart_dev_t *serial_boot_uart_dev = (SERIAL_BOOT_UART_NUM == 0) ?
70                                           &UART0 :
71                                           &UART1;
72 
73 #endif
74 
console_write(const char * str,int cnt)75 void console_write(const char *str, int cnt)
76 {
77 #ifdef CONFIG_ESP_MCUBOOT_SERIAL_USB_SERIAL_JTAG
78     usb_serial_jtag_ll_txfifo_flush();
79     while (!usb_serial_jtag_ll_txfifo_writable()) {
80         MCUBOOT_WATCHDOG_FEED();
81     }
82     usb_serial_jtag_ll_write_txfifo((const uint8_t *)str, cnt);
83     usb_serial_jtag_ll_txfifo_flush();
84 #else
85     uint32_t tx_len;
86     uint32_t write_len;
87 
88     do {
89         tx_len = uart_ll_get_txfifo_len(serial_boot_uart_dev);
90         if (tx_len > 0) {
91             write_len = tx_len < cnt ? tx_len : cnt;
92             uart_ll_write_txfifo(serial_boot_uart_dev, (const uint8_t *)str, write_len);
93             cnt -= write_len;
94         }
95         MCUBOOT_WATCHDOG_FEED();
96         esp_rom_delay_us(1000);
97     } while (cnt > 0);
98 #endif
99 }
100 
console_read(char * str,int cnt,int * newline)101 int console_read(char *str, int cnt, int *newline)
102 {
103 #ifdef CONFIG_ESP_MCUBOOT_SERIAL_USB_SERIAL_JTAG
104     uint32_t read_len = 0;
105 
106     esp_rom_delay_us(1000);
107     do {
108         if (usb_serial_jtag_ll_rxfifo_data_available()) {
109             usb_serial_jtag_ll_read_rxfifo((uint8_t *)&str[read_len], 1);
110             read_len++;
111         }
112         MCUBOOT_WATCHDOG_FEED();
113         esp_rom_delay_us(1000);
114     }  while (!(read_len == cnt || str[read_len - 1] == '\n'));
115     *newline = (str[read_len - 1] == '\n') ? 1 : 0;
116 
117     return read_len;
118 #else
119     uint32_t len = 0;
120     uint32_t read_len = 0;
121     bool stop = false;
122 
123     do {
124         len = uart_ll_get_rxfifo_len(serial_boot_uart_dev);
125 
126         if (len > 0) {
127             for (uint32_t i = 0; i < len; i++) {
128                 /* Read the character from the RX FIFO */
129                 uart_ll_read_rxfifo(serial_boot_uart_dev, (uint8_t *)&str[read_len], 1);
130                 read_len++;
131                 if (read_len == cnt - 1|| str[read_len - 1] == '\n') {
132                     stop = true;
133                     break;
134                 }
135             }
136         }
137         MCUBOOT_WATCHDOG_FEED();
138         esp_rom_delay_us(1000);
139     } while (!stop);
140 
141     *newline = (str[read_len - 1] == '\n') ? 1 : 0;
142     return read_len;
143 #endif
144 }
145 
boot_console_init(void)146 int boot_console_init(void)
147 {
148     BOOT_LOG_INF("Initializing serial boot pins");
149 
150 #ifdef CONFIG_ESP_MCUBOOT_SERIAL_USB_SERIAL_JTAG
151     usb_serial_jtag_ll_txfifo_flush();
152     esp_rom_uart_tx_wait_idle(0);
153 #else
154     /* Enable GPIO for UART RX */
155     esp_rom_gpio_pad_select_gpio(SERIAL_BOOT_GPIO_RX);
156     esp_rom_gpio_connect_in_signal(SERIAL_BOOT_GPIO_RX,
157                                    UART_PERIPH_SIGNAL(SERIAL_BOOT_UART_NUM, SOC_UART_RX_PIN_IDX),
158                                    0);
159     gpio_ll_input_enable(&GPIO, SERIAL_BOOT_GPIO_RX);
160     esp_rom_gpio_pad_pullup_only(SERIAL_BOOT_GPIO_RX);
161 
162 
163     /* Enable GPIO for UART TX */
164     esp_rom_gpio_pad_select_gpio(SERIAL_BOOT_GPIO_TX);
165     esp_rom_gpio_connect_out_signal(SERIAL_BOOT_GPIO_TX,
166                                     UART_PERIPH_SIGNAL(SERIAL_BOOT_UART_NUM, SOC_UART_TX_PIN_IDX),
167                                     0, 0);
168     gpio_ll_output_enable(&GPIO, SERIAL_BOOT_GPIO_TX);
169 
170     uart_ll_set_sclk(serial_boot_uart_dev, UART_SCLK_DEFAULT);
171     uart_ll_set_mode_normal(serial_boot_uart_dev);
172     uart_ll_set_baudrate(serial_boot_uart_dev, 115200, UART_SCLK_DEFAULT);
173     uart_ll_set_stop_bits(serial_boot_uart_dev, 1u);
174     uart_ll_set_parity(serial_boot_uart_dev, UART_PARITY_DISABLE);
175     uart_ll_set_rx_tout(serial_boot_uart_dev, 16);
176     uart_ll_set_data_bit_num(serial_boot_uart_dev, UART_DATA_8_BITS);
177     uart_ll_set_tx_idle_num(serial_boot_uart_dev, 0);
178     uart_ll_set_hw_flow_ctrl(serial_boot_uart_dev, UART_HW_FLOWCTRL_DISABLE, 100);
179     periph_ll_enable_clk_clear_rst(PERIPH_UART0_MODULE + SERIAL_BOOT_UART_NUM);
180 
181     uart_ll_txfifo_rst(serial_boot_uart_dev);
182     uart_ll_rxfifo_rst(serial_boot_uart_dev);
183     esp_rom_delay_us(50000);
184 #endif
185 
186     return 0;
187 }
188 
boot_serial_detect_pin(void)189 bool boot_serial_detect_pin(void)
190 {
191     bool detected = false;
192     int pin_value = 0;
193 
194     esp_rom_gpio_pad_select_gpio(SERIAL_BOOT_GPIO_DETECT);
195     gpio_ll_input_enable(&GPIO, SERIAL_BOOT_GPIO_DETECT);
196     switch (SERIAL_BOOT_GPIO_INPUT_TYPE) {
197         // Pull-down
198         case 0:
199             gpio_ll_pulldown_en(&GPIO, SERIAL_BOOT_GPIO_DETECT);
200             break;
201         // Pull-up
202         case 1:
203             gpio_ll_pullup_en(&GPIO, SERIAL_BOOT_GPIO_DETECT);
204             break;
205     }
206     esp_rom_delay_us(50000);
207 
208     pin_value = gpio_ll_get_level(&GPIO, SERIAL_BOOT_GPIO_DETECT);
209     detected = (pin_value == SERIAL_BOOT_GPIO_DETECT_VAL);
210     esp_rom_delay_us(50000);
211 
212     if (detected) {
213         if (SERIAL_BOOT_DETECT_DELAY_S > 0) {
214             /* The delay time is an approximation */
215             for (int i = 0; i < (SERIAL_BOOT_DETECT_DELAY_S * 100); i++) {
216                 esp_rom_delay_us(10000);
217                 pin_value = gpio_ll_get_level(&GPIO, SERIAL_BOOT_GPIO_DETECT);
218                 detected = (pin_value == SERIAL_BOOT_GPIO_DETECT_VAL);
219                 if (!detected) {
220                     break;
221                 }
222             }
223         }
224     }
225     return detected;
226 }
227