folder restructure

bt/: for bluteooth files platform/: for platform files parser/: for parser files new file: <uni.h> so that platforms and others can include it
ricardoquesada · Nov 23, 2023 · f93d12d · f93d12d
1 parent 3ad4a1b
commit f93d12d
Show file tree

Hide file tree

Showing 94 changed files with 292 additions and 257 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -36,6 +36,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Removed the "PLATFORM_PC_DEBUG" option.
   - Instead, "pc_debug" still exists, but internally uses "custom" platform.
 - Allowlist: rename `uni_bt_allowlist_allow_addr()` to `uni_bt_allowlist_is_allowed_addr()`
+- Folder organization:
+    - bt/: includes all the Bluetooth related files
+    - platform/: includes all the platform files
+    - parser:/ includes all the parser files
+    - Added <uni.h> file, easier for 3rd party user. Just include that file, and
+      and don't worry about internal folder re-organization.
 
 ## [3.10.1] - 2023-11-05
 ### New

diff --git a/examples/esp32/main/main.c b/examples/esp32/main/main.c
@@ -5,10 +5,9 @@
 
 #include <btstack_port_esp32.h>
 #include <btstack_run_loop.h>
+#include <uni.h>
 
 #include "sdkconfig.h"
-#include "uni_init.h"
-#include "uni_platform.h"
 
 // Sanity check
 #ifndef CONFIG_BLUEPAD32_PLATFORM_CUSTOM

diff --git a/examples/esp32/main/my_platform.c b/examples/esp32/main/my_platform.c
@@ -4,12 +4,7 @@
 #include <stdio.h>
 #include <string.h>
 
-#include "sdkconfig.h"
-#include "uni_bt.h"
-#include "uni_gamepad.h"
-#include "uni_hid_device.h"
-#include "uni_log.h"
-#include "uni_platform.h"
+#include <uni.h>
 
 // Custom "instance"
 typedef struct my_platform_instance_s {

diff --git a/examples/linux/Makefile b/examples/linux/Makefile
@@ -73,44 +73,44 @@ clean_src:
 	rm -rf * ${BTSTACK_ROOT}/platform/embedded/*.o
 
 bluepad32: ${CORE_OBJ} ${COMMON_OBJ} ${CLASSIC_OBJ} ${SDP_CLIENT} btstack_ring_buffer.o btstack_hid_parser.o \
+	${BLUEPAD32_ROOT}/bt/uni_bt.o \
+	${BLUEPAD32_ROOT}/bt/uni_bt_allowlist.o \
+	${BLUEPAD32_ROOT}/bt/uni_bt_bredr.o \
+	${BLUEPAD32_ROOT}/bt/uni_bt_conn.o \
+	${BLUEPAD32_ROOT}/bt/uni_bt_le.o \
+	${BLUEPAD32_ROOT}/bt/uni_bt_sdp.o \
+	${BLUEPAD32_ROOT}/bt/uni_bt_setup.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser_8bitdo.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser_android.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser_atari.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser_ds3.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser_ds4.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser_ds5.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser_generic.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser_icade.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser_keyboard.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser_mouse.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser_nimbus.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser_ouya.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser_psmove.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser_smarttvremote.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser_steam.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser_switch.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser_wii.o \
+	${BLUEPAD32_ROOT}/parser/uni_hid_parser_xboxone.o \
+	${BLUEPAD32_ROOT}/platform/uni_platform.o \
 	${BLUEPAD32_ROOT}/uni_balance_board.o \
-	${BLUEPAD32_ROOT}/uni_bt.o \
-	${BLUEPAD32_ROOT}/uni_bt_allowlist.o \
-	${BLUEPAD32_ROOT}/uni_bt_bredr.o \
-	${BLUEPAD32_ROOT}/uni_bt_conn.o \
-	${BLUEPAD32_ROOT}/uni_bt_le.o \
-	${BLUEPAD32_ROOT}/uni_bt_sdp.o \
-	${BLUEPAD32_ROOT}/uni_bt_setup.o \
 	${BLUEPAD32_ROOT}/uni_circular_buffer.o \
 	${BLUEPAD32_ROOT}/uni_controller.o \
 	${BLUEPAD32_ROOT}/uni_gamepad.o \
 	${BLUEPAD32_ROOT}/uni_hci_cmd.o \
 	${BLUEPAD32_ROOT}/uni_hid_device.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser_8bitdo.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser_android.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser_atari.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser_ds3.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser_ds4.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser_ds5.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser_generic.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser_icade.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser_keyboard.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser_mouse.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser_nimbus.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser_ouya.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser_psmove.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser_smarttvremote.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser_steam.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser_switch.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser_wii.o \
-	${BLUEPAD32_ROOT}/uni_hid_parser_xboxone.o \
 	${BLUEPAD32_ROOT}/uni_init.o \
 	${BLUEPAD32_ROOT}/uni_joystick.o \
 	${BLUEPAD32_ROOT}/uni_keyboard.o \
 	${BLUEPAD32_ROOT}/uni_log.o \
 	${BLUEPAD32_ROOT}/uni_mouse.o \
-	${BLUEPAD32_ROOT}/uni_platform.o \
 	${BLUEPAD32_ROOT}/uni_property.o \
 	${BLUEPAD32_ROOT}/uni_property_mem.o \
 	${BLUEPAD32_ROOT}/uni_utils.o \

diff --git a/examples/linux/main.c b/examples/linux/main.c
@@ -76,9 +76,9 @@
 #include "hci_transport_usb.h"
 
 // Bluepad32 related
+#include <uni.h>
+
 #include "sdkconfig.h"
-#include "uni_init.h"
-#include "uni_platform.h"
 
 // Local includes
 #include "my_platform.h"

diff --git a/examples/linux/my_platform.c b/examples/linux/my_platform.c
@@ -21,13 +21,7 @@ limitations under the License.
 #include <stdio.h>
 #include <string.h>
 
-#include "uni_bt.h"
-#include "uni_error.h"
-#include "uni_gamepad.h"
-#include "uni_hid_device.h"
-#include "uni_hid_parser_mouse.h"
-#include "uni_log.h"
-#include "uni_platform.h"
+#include <uni.h>
 
 //
 // Globals

diff --git a/examples/linux/my_platform.h b/examples/linux/my_platform.h
@@ -1,7 +1,7 @@
 #ifndef MY_PLATFORM
 #define MY_PLATFORM
 
-#include "uni_platform.h"
+#include <uni.h>
 
 struct uni_platform* get_my_platform(void);
 

diff --git a/examples/pico_w/src/main.c b/examples/pico_w/src/main.c
@@ -4,11 +4,9 @@
 #include <btstack_run_loop.h>
 #include <pico/cyw43_arch.h>
 #include <pico/stdlib.h>
+#include <uni.h>
 
 #include "sdkconfig.h"
-#include "uni_init.h"
-#include "uni_log.h"
-#include "uni_platform.h"
 
 // Sanity check
 #ifndef CONFIG_BLUEPAD32_PLATFORM_CUSTOM

diff --git a/examples/pico_w/src/my_platform.c b/examples/pico_w/src/my_platform.c
@@ -5,13 +5,9 @@
 #include <string.h>
 
 #include <pico/cyw43_arch.h>
+#include <uni.h>
 
 #include "sdkconfig.h"
-#include "uni_bt.h"
-#include "uni_gamepad.h"
-#include "uni_hid_device.h"
-#include "uni_log.h"
-#include "uni_platform.h"
 
 // Sanity check
 #ifndef CONFIG_BLUEPAD32_PLATFORM_CUSTOM

diff --git a/src/components/bluepad32/CMakeLists.txt b/src/components/bluepad32/CMakeLists.txt
@@ -1,41 +1,42 @@
-set(srcs "uni_balance_board.c"
-         "uni_bt.c"
-         "uni_bt_allowlist.c"
-         "uni_bt_conn.c"
-         "uni_bt_le.c"
-         "uni_bt_setup.c"
+set(srcs
+         "bt/uni_bt.c"
+         "bt/uni_bt_allowlist.c"
+         "bt/uni_bt_conn.c"
+         "bt/uni_bt_le.c"
+         "bt/uni_bt_setup.c"
+         "parser/uni_hid_parser.c"
+         "parser/uni_hid_parser_8bitdo.c"
+         "parser/uni_hid_parser_android.c"
+         "parser/uni_hid_parser_atari.c"
+         "parser/uni_hid_parser_ds3.c"
+         "parser/uni_hid_parser_ds4.c"
+         "parser/uni_hid_parser_ds5.c"
+         "parser/uni_hid_parser_generic.c"
+         "parser/uni_hid_parser_icade.c"
+         "parser/uni_hid_parser_keyboard.c"
+         "parser/uni_hid_parser_mouse.c"
+         "parser/uni_hid_parser_nimbus.c"
+         "parser/uni_hid_parser_ouya.c"
+         "parser/uni_hid_parser_psmove.c"
+         "parser/uni_hid_parser_smarttvremote.c"
+         "parser/uni_hid_parser_steam.c"
+         "parser/uni_hid_parser_switch.c"
+         "parser/uni_hid_parser_wii.c"
+         "parser/uni_hid_parser_xboxone.c"
+         "platform/uni_platform.c"
+         "platform/uni_platform_arduino.c"
+         "platform/uni_platform_arduino_bootstrap.cpp"
+         "uni_balance_board.c"
          "uni_circular_buffer.c"
          "uni_controller.c"
          "uni_gamepad.c"
          "uni_hci_cmd.c"
          "uni_hid_device.c"
-         "uni_hid_parser.c"
-         "uni_hid_parser_8bitdo.c"
-         "uni_hid_parser_android.c"
-         "uni_hid_parser_atari.c"
-         "uni_hid_parser_ds3.c"
-         "uni_hid_parser_ds4.c"
-         "uni_hid_parser_ds5.c"
-         "uni_hid_parser_generic.c"
-         "uni_hid_parser_icade.c"
-         "uni_hid_parser_keyboard.c"
-         "uni_hid_parser_mouse.c"
-         "uni_hid_parser_nimbus.c"
-         "uni_hid_parser_ouya.c"
-         "uni_hid_parser_psmove.c"
-         "uni_hid_parser_smarttvremote.c"
-         "uni_hid_parser_steam.c"
-         "uni_hid_parser_switch.c"
-         "uni_hid_parser_wii.c"
-         "uni_hid_parser_xboxone.c"
          "uni_init.c"
          "uni_joystick.c"
          "uni_keyboard.c"
          "uni_log.c"
          "uni_mouse.c"
-         "uni_platform.c"
-         "uni_platform_arduino.c"
-         "uni_platform_arduino_bootstrap.cpp"
          "uni_property.c"
          "uni_utils.c"
          "uni_virtual_device.c")
@@ -46,8 +47,8 @@ if(CONFIG_IDF_TARGET_ESP32 OR PICO_SDK_VERSION_STRING)
     # - Pico W
     list(APPEND srcs
          # BR/EDR code only gets compiled on ESP32
-         "uni_bt_bredr.c"
-         "uni_bt_sdp.c")
+         "bt/uni_bt_bredr.c"
+         "bt/uni_bt_sdp.c")
 endif()
 
 if(IDF_TARGET)
@@ -72,15 +73,15 @@ if(CONFIG_IDF_TARGET_ESP32)
     # Files that are only meant to be compiled on ESP32 (original)
     list(APPEND srcs
         # Place here files that are ESP32-only
-         "uni_platform_mightymiggy.c"
-         "uni_platform_nina.c"
-         "uni_platform_unijoysticle.c"
-         "uni_platform_unijoysticle_2.c"
-         "uni_platform_unijoysticle_2plus.c"
-         "uni_platform_unijoysticle_800xl.c"
-         "uni_platform_unijoysticle_a500.c"
-         "uni_platform_unijoysticle_c64.c"
-         "uni_platform_unijoysticle_singleport.c")
+         "platform/uni_platform_mightymiggy.c"
+         "platform/uni_platform_nina.c"
+         "platform/uni_platform_unijoysticle.c"
+         "platform/uni_platform_unijoysticle_2.c"
+         "platform/uni_platform_unijoysticle_2plus.c"
+         "platform/uni_platform_unijoysticle_800xl.c"
+         "platform/uni_platform_unijoysticle_a500.c"
+         "platform/uni_platform_unijoysticle_c64.c"
+         "platform/uni_platform_unijoysticle_singleport.c")
 endif()
 
 # Valid for ESP-IDF only

diff --git a/src/components/bluepad32/uni_bt.c → src/components/bluepad32/bt/uni_bt.c b/src/components/bluepad32/uni_bt.c → src/components/bluepad32/bt/uni_bt.c
@@ -52,7 +52,7 @@
  * this file.
  */
 
-#include "uni_bt.h"
+#include "bt/uni_bt.h"
 
 #include <btstack.h>
 #include <btstack_config.h>
@@ -63,21 +63,22 @@
 #include <string.h>
 
 #include "sdkconfig.h"
-#include "uni_bt.h"
-#include "uni_bt_bredr.h"
-#include "uni_bt_conn.h"
-#include "uni_bt_defines.h"
-#include "uni_bt_le.h"
-#include "uni_bt_sdp.h"
-#include "uni_bt_setup.h"
+
+#include "bt/uni_bt.h"
+#include "bt/uni_bt_bredr.h"
+#include "bt/uni_bt_conn.h"
+#include "bt/uni_bt_defines.h"
+#include "bt/uni_bt_le.h"
+#include "bt/uni_bt_sdp.h"
+#include "bt/uni_bt_setup.h"
+#include "parser/uni_hid_parser.h"
+#include "platform/uni_platform.h"
 #include "uni_common.h"
 #include "uni_config.h"
 #include "uni_hci_cmd.h"
 #include "uni_hid_device.h"
 #include "uni_hid_device_vendors.h"
-#include "uni_hid_parser.h"
 #include "uni_log.h"
-#include "uni_platform.h"
 #include "uni_property.h"
 
 // globals

diff --git a/src/components/bluepad32/uni_bt_allowlist.c → ...omponents/bluepad32/bt/uni_bt_allowlist.c b/src/components/bluepad32/uni_bt_allowlist.c → ...omponents/bluepad32/bt/uni_bt_allowlist.c
@@ -16,9 +16,10 @@ See the License for the specific language governing permissions and
 limitations under the License.
 ****************************************************************************/
 
-#include "uni_bt_allowlist.h"
+#include "bt/uni_bt_allowlist.h"
 
 #include "sdkconfig.h"
+
 #include "uni_common.h"
 #include "uni_log.h"
 #include "uni_property.h"

diff --git a/src/components/bluepad32/uni_bt_bredr.c → src/components/bluepad32/bt/uni_bt_bredr.c b/src/components/bluepad32/uni_bt_bredr.c → src/components/bluepad32/bt/uni_bt_bredr.c
@@ -16,18 +16,19 @@ See the License for the specific language governing permissions and
 limitations under the License.
 ****************************************************************************/
 
-#include "uni_bt_bredr.h"
+#include "bt/uni_bt_bredr.h"
 
 #include <inttypes.h>
 #include <stdbool.h>
 
 #include <btstack.h>
 
 #include "sdkconfig.h"
-#include "uni_bt.h"
-#include "uni_bt_allowlist.h"
-#include "uni_bt_defines.h"
-#include "uni_bt_sdp.h"
+
+#include "bt/uni_bt.h"
+#include "bt/uni_bt_allowlist.h"
+#include "bt/uni_bt_defines.h"
+#include "bt/uni_bt_sdp.h"
 #include "uni_common.h"
 #include "uni_config.h"
 #include "uni_log.h"

diff --git a/src/components/bluepad32/uni_bt_conn.c → src/components/bluepad32/bt/uni_bt_conn.c b/src/components/bluepad32/uni_bt_conn.c → src/components/bluepad32/bt/uni_bt_conn.c
@@ -16,7 +16,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 ****************************************************************************/
 
-#include "uni_bt_conn.h"
+#include "bt/uni_bt_conn.h"
 
 #include <string.h>
 

diff --git a/src/components/bluepad32/uni_bt_le.c → src/components/bluepad32/bt/uni_bt_le.c b/src/components/bluepad32/uni_bt_le.c → src/components/bluepad32/bt/uni_bt_le.c
@@ -50,7 +50,7 @@
  *  uni_hid_device_set_ready()
  */
 
-#include "uni_bt_le.h"
+#include "bt/uni_bt_le.h"
 
 #include <bluetooth_data_types.h>
 #include <btstack.h>
@@ -61,13 +61,14 @@
 #include <stdlib.h>
 
 #include "sdkconfig.h"
-#include "uni_bt_allowlist.h"
-#include "uni_bt_conn.h"
-#include "uni_bt_defines.h"
+
+#include "bt/uni_bt_allowlist.h"
+#include "bt/uni_bt_conn.h"
+#include "bt/uni_bt_defines.h"
+#include "parser/uni_hid_parser.h"
 #include "uni_common.h"
 #include "uni_config.h"
 #include "uni_hid_device.h"
-#include "uni_hid_parser.h"
 #include "uni_log.h"
 #include "uni_property.h"