Armino 1.2.0

We are pleased to announce the release of Armino version 1.2.0.

备注

Armino is not designed from scratch, the baseline of Armino 1.2.0 is Beken Wi-Fi SDK v3.0, which has been used by many customers around the world. A lot of enhancements and changes have been made in Armino 1.2.0 compares to it’s baseline, that’s what we annouced in this release notes.

Major enhancements with this release include:

• Support new software architecture, such as components and middleware etc

• Support boot for RISC-V

• Support new APIs for following drivers:

  • ADC

  • GPIO

  • DMA

  • UART

  • SPI

  • QSPI

  • Timer

  • TRNG

  • MailBox

  • Interrupt

  • Watchdog

  • Efusea

  • PWM

  • Vault

• Support Wi-Fi 6 stack

• Support new APIs for Wi-Fi

• Support new APIs for BLE

• Support BLE 5.x stack

• Support POSIX for FreeRTOS

• Upgrade FreeRTOS to v10.0

• Upgrade LWIP to v2.1.2

• Support CMake build

• Support Kconfig and per-soc and per-project configuration

• Support new documentation

The following sections provide detailed lists of changes by component.

Software Architecture

The software architecture has been redesigned:

• A dedicated layer components has been added, it’s used to contain the reusable or service related modules.

• A dedicated layer middleware has been added, it works as the adapter between hardware and other components.

• A dedicated layer projects has been added to contains all applications, projects or examples.

• The FreeRTOS have been moved to Armino, Armino supports FreeRTOS by default.

FreeRTOS

The FreeRTOS has been upgrade from v9.0 to v10.0.

Posix APIs

The POSIX APIs has been supported.

Wi-Fi

• Support Wi-Fi 6 stack

• Support new Wi-Fi APIs

• bk_wifi_init() - init WiFi

• bk_wifi_deinit() - deinit WiFi

• bk_wifi_set_country() - set country code

• bk_wifi_get_country() - get country code

• bk_wifi_send_raw() - send raw 802.11 frame

• bk_wifi_sta_start() - start BK STA

• bk_wifi_sta_stop() - stop BK STA

• bk_wifi_sta_set_config() - set basic configurations BK STA, such as SSID etc

• bk_wifi_sta_get_config() - get basic configuration of BK STA

• bk_wifi_sta_get_link_status() - get link status of BK STA

• bk_wifi_sta_get_mac() - get STA MAC address

• bk_wifi_ap_start() - start BK AP

• bk_wifi_ap_stop() - stop BK AP

• bk_wifi_ap_set_config() - set the basic configuration of BK AP, such as SSID etc

• bk_wifi_ap_get_config() - get the basic configuration of BK AP

• bk_wifi_ap_get_mac() - get AP MAC address

• bk_wifi_monitor_start() - start the monitor

• bk_wifi_monitor_stop() - stop the monitor

• bk_wifi_monitor_set_config() - set basic configuration of the monitor

• bk_wifi_monitor_get_config() - get basic configuration of the monitor

• bk_wifi_monitor_register_cb() - register monitor callback function

• bk_wifi_monitor_set_channel() - set the channel of monitor

• bk_wifi_scan_register_cb() - register scan callback function

• bk_wifi_scan_start() - start the scan

• bk_wifi_scan_stop() - stop the scan

• bk_wifi_scan_get_result() - get the scan result

• bk_wifi_scan_dump_result() - dump the scan result

• bk_wifi_scan_free_result() - dump the scan result

• bk_wifi_filter_set_config() - set filter configuration

• bk_wifi_filter_register_cb() - register the filter callback function

BLE

Driver

The driver architecture has been redesigned:

• The driver has been divided to 3 layers, the Driver layer, HAL layer and SoC Layer.

• Some driver of the peripherals are re-implemented based on the new driver architecture, such as ADC etc.

ADC

ADC are re-designed in this release, here are the new ADC APIs:

• bk_adc_driver_init()

• bk_adc_aquire()

• bk_adc_release()

• bk_adc_driver_deinit()

• bk_adc_init()

• bk_adc_deinit()

• bk_adc_start()

• bk_adc_stop()

• bk_adc_read_raw()

• bk_adc_read()

• bk_adc_register_isr()

• bk_adc_set_clk()

• bk_adc_set_channel()

• bk_adc_set_sample_rate()

• bk_adc_set_filter()

• bk_adc_set_steady_time()

• bk_adc_set_sample_cnt()

• bk_adc_enable_saturate()

• bk_adc_disable_saturate()

• bk_adc_set_saturate()

• bk_adc_get_saturate()

• bk_adc_set_config()

• bk_adc_set_mode()

• bk_adc_get_mode()

GPIO

GPIO are re-designed in this release, here are the new GPIO APIs:

• bk_gpio_driver_init()

• bk_gpio_driver_deinit()

• bk_gpio_enable_output()

• bk_gpio_disable_output()

• bk_gpio_enable_input()

• bk_gpio_disable_input()

• bk_gpio_enable_pull()

• bk_gpio_disable_pull()

• bk_gpio_pull_up()

• bk_gpio_pull_down()

• bk_gpio_set_output_high()

• bk_gpio_set_output_low()

• bk_gpio_get_input()

• bk_gpio_set_config()

• bk_gpio_register_isr()

• bk_gpio_enable_interrupt()

• bk_gpio_disable_interrupt()

• bk_gpio_set_interrupt_type()

PWM

PWM are re-designed in this release, here are the new PWM APIs:

• bk_pwm_driver_init()

• bk_pwm_driver_deinit()

• bk_pwm_init()

• bk_pwm_deinit()

• bk_pwm_set_duty_period()

• bk_pwm_start()

• bk_pwm_stop()

• bk_pwm_set_init_signal_low()

• bk_pwm_set_init_signal_high()

• bk_pwm_register_isr()

• bk_pwm_enable_interrupt()

• bk_pwm_disable_interrupt()

• bk_pwm_group_init()

• bk_pwm_group_deinit()

• bk_pwm_group_start()

• bk_pwm_group_stop()

• bk_pwm_capture_init()

• bk_pwm_capture_deinit()

• bk_pwm_capture_start()

• bk_pwm_capture_stop()

• bk_pwm_capture_get_value()

DMA

DMA are re-designed in this release, here are the new DMA APIs:

• bk_dma_driver_init()

• bk_dma_driver_deinit()

• bk_dma_init()

• bk_dma_deinit()

• bk_dma_start()

• bk_dma_stop()

• bk_dma_write()

• bk_dma_read()

• bk_dma_enable_finish_interrupt()

• bk_dma_disable_finish_interrupt()

• bk_dma_enable_half_finish_interrupt()

• bk_dma_disable_half_finish_interrupt()

• bk_dma_register_isr()

• bk_dma_set_transfer_len()

• bk_dma_set_src_addr()

• bk_dma_set_dest_addr()

• bk_dma_get_remain_len()

UART

UART are re-designed in this release, here are the new UART APIs:

• bk_uart_driver_init()

• bk_uart_driver_deinit()

• bk_uart_init()

• bk_uart_deinit()

• bk_uart_set_baud_rate()

• bk_uart_set_data_bits()

• bk_uart_set_stop_bits()

• bk_uart_set_parity()

• bk_uart_set_hw_flow_ctrl()

• bk_uart_set_rx_full_threshold()

• bk_uart_set_tx_empty_threshold()

• bk_uart_set_rx_timeout()

• bk_uart_disable_hw_flow_ctrl()

• bk_uart_enable_tx_interrupt()

• bk_uart_disable_tx_interrupt()

• bk_uart_enable_rx_interrupt()

• bk_uart_disable_rx_interrupt()

• bk_uart_register_rx_isr()

• bk_uart_register_tx_isr()

• bk_uart_write_bytes()

• bk_uart_read_bytes()

• bk_uart_disable_rx()

• bk_uart_disable_tx()

• bk_uart_enable_sw_fifo()

• bk_uart_disable_sw_fifo()

SPI

SPI are re-designed in this release, here are the new SPI APIs:

• bk_spi_driver_init()

• bk_spi_driver_deinit()

• bk_spi_init()

• bk_spi_deinit()

• bk_spi_set_mode()

• bk_spi_set_bit_width()

• bk_spi_set_wire_mode()

• bk_spi_set_baud_rate()

• bk_spi_set_bit_order()

• bk_spi_register_rx_isr()

• bk_spi_register_tx_finish_isr()

• bk_spi_write_bytes()

• bk_spi_read_bytes()

• bk_spi_transmit()

• bk_spi_dma_write_bytes()

• bk_spi_dma_read_bytes()

• bk_spi_dma_transmit()

QSPI

QSPI driver are re-designed in this release, here are the new QSPI APIs:

• bk_qspi_driver_init()

• bk_qspi_driver_deinit()

• bk_qspi_init()

• bk_qspi_deinit()

• bk_qspi_command()

• bk_qspi_write()

• bk_qspi_read()

• bk_qspi_register_tx_isr()

• bk_qspi_register_rx_isr()

• bk_qspi_psram_init()

• bk_qspi_psram_deinit()

• bk_qspi_psram_enter_quad_mode()

• bk_qspi_psram_exit_quad_mode()

• bk_qspi_psram_quad_write()

• bk_qspi_psram_single_write()

• bk_qspi_psram_quad_read()

• bk_qspi_psram_single_read()

• bk_qspi_psram_write()

• bk_qspi_psram_read()

Timer

Timer driver are re-designed in this release, here are the new Timer APIs:

• bk_timer_driver_init()

• bk_timer_driver_deinit()

• bk_timer_start()

• bk_timer_stop()

• bk_timer_get_cnt()

• bk_timer_enable()

• bk_timer_disable()

• bk_timer_get_period()

TRNG

TRNG driver are re-designed in this release, here are the new TRNG APIs:

• bk_trng_driver_init()

• bk_trng_driver_deinit()

• bk_trng_start()

• bk_trng_stop()

• bk_rand()

EFUSE

Efuse driver are re-designed in this release, here are the new Efuse APIs:

• bk_efuse_driver_init()

• bk_efuse_driver_deinit()

• bk_efuse_write()

• bk_efuse_read()

MailBox

Mailbox driver are re-designed in this release, here are the new Mailbox APIs:

• mailbox_init()

• mailbox_deinit()

• mailbox_set_param()

• mailbox_recv_callback_register()

• mailbox_recv_callback_unregister()

• mailbox_send()

Interrupt

Interrupt control are re-designed in this release, here are the new Interrupt APIs:

• bk_int_isr_register()

• bk_int_isr_unregister()

• bk_int_set_priority()

• bk_int_set_group()

• bk_get_int_statis()

• bk_dump_int_statis()

Watchdog

Watchdog are re-designed in this release, here are the new Watchdog APIs:

• bk_wdt_driver_init()

• bk_wdt_driver_deinit()

• bk_wdt_start()

• bk_wdt_stop()

• bk_wdt_feed()

Build System

The legacy GNU Makefile build system has been removed and the CMake build system has been supported.

Log

Following log APIs have been added:

• BK_LOGI

• BK_LOGD

• BK_LOGV

Event

Following Event APIs have been added:

• bk_event_register_cb()

• bk_event_unregister_cb()

• bk_event_post()

Netif

Following Netif APIs have been added:

• bk_netif_init()

• bk_netif_set_ip4_config()

• bk_netif_get_ip4_config()

Documentation

New documentation framework has been added to this release.

Examples

Following examples has been added:

• hello world

• ADC

• DMA

• GPIO

• Interrupt

• PWM

• SPI

• Timer

• Uart

• Soft-AP

• Wi-Fi Scan

• Station

• Build System