Begin documenting Mbed OS target features and components (#240)

* Start on documenting features and components

* Missed some renames

* Go through all cellular and 802.15.4 modules

* Fix build

* Fix style

* Update copyright year
pull/15494/head
Jamie Smith 2024-02-08 22:46:20 -08:00 committed by GitHub
parent d1b0ccaa8b
commit f19273aa7a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
228 changed files with 732 additions and 2876 deletions

View File

@ -1,22 +1,43 @@
# Copyright (c) 2020 ARM Limited. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
add_library(mbed-802.15.4-rf STATIC EXCLUDE_FROM_ALL)
# The 'mbed-802.15.4-rf' target is lazily created because there might not be any subdirectories needing it at all.
macro(create_802_15_4_target)
if(NOT TARGET create_802_15_4_target)
add_library(mbed-802.15.4-rf STATIC EXCLUDE_FROM_ALL)
# Nanostack drivers always require Mbed RTOS
target_link_libraries(mbed-802.15.4-rf PUBLIC mbed-core-flags mbed-rtos-flags)
target_link_libraries(mbed-nanostack
INTERFACE
mbed-802.15.4-rf
)
endif()
endmacro()
target_link_libraries(mbed-802.15.4-rf PUBLIC mbed-core-flags)
if("Freescale" IN_LIST MBED_TARGET_LABELS)
create_802_15_4_target()
add_subdirectory(TARGET_Freescale)
add_subdirectory(mcr20a-rf-driver)
elseif("Silicon_Labs" IN_LIST MBED_TARGET_LABELS)
create_802_15_4_target()
add_subdirectory(TARGET_Silicon_Labs)
elseif("STM" IN_LIST MBED_TARGET_LABELS)
add_subdirectory(stm-s2lp-rf-driver)
endif()
add_subdirectory(atmel-rf-driver)
if("COMPONENT_MICROCHIP_AT86RF=1" IN_LIST MBED_TARGET_DEFINITIONS)
create_802_15_4_target()
add_subdirectory(COMPONENT_MICROCHIP_AT86RF)
endif()
if("COMPONENT_NXP_MCR20A=1" IN_LIST MBED_TARGET_DEFINITIONS)
create_802_15_4_target()
add_subdirectory(COMPONENT_NXP_MCR20A)
endif()
if("COMPONENT_STM_S2_LP=1" IN_LIST MBED_TARGET_DEFINITIONS)
create_802_15_4_target()
add_subdirectory(COMPONENT_STM_S2_LP)
endif()
target_link_libraries(mbed-nanostack
INTERFACE
mbed-802.15.4-rf
)

View File

@ -1,4 +1,6 @@
# Copyright (c) 2020 ARM Limited. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
add_subdirectory(ALT1250)
if("COMPONENT_ALTAIR_ALT1250=1" IN_LIST MBED_TARGET_DEFINITIONS)
add_subdirectory(COMPONENT_ALTAIR_ALT1250)
endif()

View File

@ -1,7 +1,7 @@
# Copyright (c) 2020 ARM Limited. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
if("STMOD_CELLULAR" IN_LIST MBED_TARGET_LABELS)
if("COMPONENT_STMOD_CELLULAR=1" IN_LIST MBED_TARGET_DEFINITIONS)
add_subdirectory(COMPONENT_STMOD_CELLULAR)
endif()
@ -11,10 +11,4 @@ add_subdirectory(GENERIC)
add_subdirectory(MultiTech)
add_subdirectory(QUECTEL)
add_subdirectory(RiotMicro)
add_subdirectory(TELIT)
add_subdirectory(UBLOX)
target_include_directories(mbed-cellular
PUBLIC
.
)
add_subdirectory(TELIT)

View File

@ -1,4 +1,6 @@
# Copyright (c) 2020 ARM Limited. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
add_subdirectory(CINTERION)
if("COMPONENT_GEMALTO_CINTERION=1" IN_LIST MBED_TARGET_DEFINITIONS)
add_subdirectory(CINTERION)
endif()

View File

@ -1,4 +1,6 @@
# Copyright (c) 2020 ARM Limited. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
add_subdirectory(GENERIC_AT3GPP)
if("COMPONENT_GENERIC_AT3GPP=1" IN_LIST MBED_TARGET_DEFINITIONS)
add_subdirectory(COMPONENT_GENERIC_AT3GPP)
endif()

View File

@ -1,4 +1,6 @@
# Copyright (c) 2020 ARM Limited. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
add_subdirectory(DragonflyNano)
if("COMPONENT_MULTITECH_DRAGONFLY_NANO_CELLULAR=1" IN_LIST MBED_TARGET_DEFINITIONS)
add_subdirectory(COMPONENT_MULTITECH_DRAGONFLY_NANO_CELLULAR)
endif()

View File

@ -11,3 +11,7 @@ target_sources(mbed-cellular
SARA4_PPP.cpp
SARA4_PPP_CellularNetwork.cpp
)
if("MTS_DRAGONFLY_L471QG" IN_LIST MBED_TARGET_LABELS)
add_subdirectory(TARGET_MTS_DRAGONFLY_L471QG)
endif()

View File

@ -1,4 +1,4 @@
# Copyright (c) 2020 ARM Limited. All rights reserved.
# Copyright (c) 2024 ARM Limited. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
target_include_directories(mbed-cellular
@ -8,5 +8,5 @@ target_include_directories(mbed-cellular
target_sources(mbed-cellular
PRIVATE
TELIT_HE910.cpp
)
ONBOARD_SARA4_PPP.cpp
)

View File

@ -111,7 +111,7 @@ void ONBOARD_SARA4_PPP::onboard_modem_deinit()
void ONBOARD_SARA4_PPP::onboard_modem_power_up()
{
// Make sure the radio is initialized so it can be powered on.
if (!initialized){
if (!initialized) {
onboard_modem_init();
}
@ -129,7 +129,7 @@ void ONBOARD_SARA4_PPP::onboard_modem_power_up()
uint8_t retries = 5;
do {
// If it hasn't turned on after multiple tries, exit and return.
if(0 == retries--) {
if (0 == retries--) {
return;
}
// Activate PWR_ON for 150ms-3.2s to switch on. Reference ublox SARA-R4 data sheet.
@ -153,7 +153,7 @@ void ONBOARD_SARA4_PPP::onboard_modem_power_down()
}
// Make sure the I/O are properly initialized.
if (!initialized){
if (!initialized) {
onboard_modem_init();
}
// Activate PWR_ON for at least 1.5s to switch off. Reference ublox SARA-R4 data sheet.

View File

@ -1,8 +1,23 @@
# Copyright (c) 2020 ARM Limited. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
add_subdirectory(BC95)
add_subdirectory(BG96)
add_subdirectory(EC2X)
add_subdirectory(M26)
add_subdirectory(UG96)
if("COMPONENT_QUECTEL_EC2X=1" IN_LIST MBED_TARGET_DEFINITIONS)
add_subdirectory(COMPONENT_QUECTEL_EC2X)
endif()
if("COMPONENT_QUECTEL_BG96=1" IN_LIST MBED_TARGET_DEFINITIONS OR ("COMPONENT_STMOD_CELLULAR=1" IN_LIST MBED_TARGET_DEFINITIONS AND "MBED_CONF_STMOD_CELLULAR_TYPE=STMOD_BG96"))
add_subdirectory(COMPONENT_QUECTEL_BG96)
endif()
if("COMPONENT_QUECTEL_UG96=1" IN_LIST MBED_TARGET_DEFINITIONS OR ("COMPONENT_STMOD_CELLULAR=1" IN_LIST MBED_TARGET_DEFINITIONS AND "MBED_CONF_STMOD_CELLULAR_TYPE=STMOD_UG96"))
add_subdirectory(COMPONENT_QUECTEL_UG96)
endif()
if("COMPONENT_QUECTEL_BC95=1" IN_LIST MBED_TARGET_DEFINITIONS)
add_subdirectory(COMPONENT_QUECTEL_BC95)
endif()
if("COMPONENT_QUECTEL_M26=1" IN_LIST MBED_TARGET_DEFINITIONS)
add_subdirectory(COMPONENT_QUECTEL_M26)
endif()

View File

@ -14,3 +14,7 @@ target_sources(mbed-cellular
QUECTEL_BC95_CellularNetwork.cpp
QUECTEL_BC95_CellularStack.cpp
)
if("TARGET_ADV_WISE_1570" IN_LIST MBED_TARGET_LABELS)
add_subdirectory(TARGET_ADV_WISE_1570)
endif()

View File

@ -0,0 +1,12 @@
# Copyright (c) 2024 ARM Limited. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
target_include_directories(mbed-cellular
PUBLIC
.
)
target_sources(mbed-cellular
PRIVATE
ONBOARD_QUECTEL_BC95.cpp
)

View File

@ -15,3 +15,7 @@ target_sources(mbed-cellular
QUECTEL_BG96_CellularStack.cpp
QUECTEL_BG96_ControlPlane_netif.cpp
)
if("TARGET_WIO_BG96" IN_LIST MBED_TARGET_LABELS)
add_subdirectory(TARGET_WIO_BG96)
endif()

Some files were not shown because too many files have changed in this diff Show More