ตั้งค่าสภาพแวดล้อมของบิลด์

ดูแหล่งข้อมูลใน GitHub

หากต้องการโปรโมตการพัฒนาอย่างอิสระและเปิดกว้าง OpenThread จะใช้ CMake ในเครื่องมือสร้างบิลด์ ปัจจุบันเครื่องมือนี้ต้องใช้สําหรับการโอน OpenThread ไปยังแพลตฟอร์มฮาร์ดแวร์ใหม่

ในอนาคตอาจมีการรองรับเครื่องมือบิลด์อื่นๆ แต่อยู่ภายในขอบเขตของคู่มือการย้ายนี้

สร้างที่เก็บใหม่

ขั้นตอนแรกคือการตั้งค่าบ้านใหม่สําหรับแพลตฟอร์มฮาร์ดแวร์ของคุณ ในคู่มือนี้ เราจะสร้างที่เก็บใหม่ชื่อ ot-efr32 ซึ่งมีเลเยอร์นามธรรมของแพลตฟอร์ม, SDK ของแพลตฟอร์มฮาร์ดแวร์ และสคริปต์ที่เป็นประโยชน์ 2-3 รายการ

ในตัวอย่างนี้ เราสร้างที่เก็บ SiliconLabs/ot-efr32 บน GitHub และโคลนไปยัง ~/repos/ot-efr32 แล้ว

mkdir -p ~/repos
cd ~/repos
git clone git@github.com:SiliconLabs/ot-efr32.git
Cloning into 'ot-efr32'...
remote: Enumerating objects: 99, done.
remote: Counting objects: 100% (99/99), done.
remote: Compressing objects: 100% (60/60), done.
remote: Total 333 (delta 65), reused 39 (delta 39), pack-reused 234
Receiving objects: 100% (333/333), 170.78 KiB | 5.69 MiB/s, done.
Resolving deltas: 100% (194/194), done.
git status
On branch main
Your branch is up to date with 'origin/main'.

nothing to commit, working tree clean

โครงสร้างที่เก็บ

เพื่อให้สอดคล้องกับที่เก็บแพลตฟอร์มที่มีอยู่ในองค์กร OpenThread GitHub คุณอาจต้องจัดโครงสร้างที่เก็บดังนี้

tree -F -L 1 --dirsfirst
.
├── examples/
├── openthread/
├── script/
├── src/
├── third_party/
├── CMakeLists.txt
├── LICENSE
└── README.md
โฟลเดอร์ คำอธิบาย
examples ไม่บังคับตัวอย่างแอปพลิเคชัน
openthread ที่เก็บของ openthread เป็นโมดูลย่อย
script สคริปต์สําหรับสร้าง ทดสอบ วิเคราะห์โค้ด
src การใช้เลเยอร์นามธรรมแบบแพลตฟอร์ม
third_party ตําแหน่งสําหรับแหล่งที่มาของบุคคลที่สาม

เพิ่มโมดูลย่อย

ขั้นตอนถัดไปคือเพิ่ม openthread และที่เก็บที่จําเป็นอื่นๆ เป็นโมดูลย่อย

git submodule add git@github.com:openthread/openthread.git
Cloning into '/home/user/repos/ot-efr32/openthread'...
remote: Enumerating objects: 78281, done.
remote: Counting objects: 100% (1056/1056), done.
remote: Compressing objects: 100% (488/488), done.
remote: Total 78281 (delta 639), reused 864 (delta 556), pack-reused 77225
Receiving objects: 100% (78281/78281), 76.62 MiB | 35.24 MiB/s, done.
Resolving deltas: 100% (61292/61292), done.

สําหรับตัวอย่างนี้ เราจะเพิ่ม Silicon Labs Gecko SDK เวอร์ชัน Lite เป็นโมดูลย่อยใน third_party

cd third_party
git submodule add git@github.com:SiliconLabs/sdk_support.git
Cloning into '/home/user/repos/ot-efr32/third_party/sdk_support'...
remote: Enumerating objects: 32867, done.
remote: Counting objects: 100% (8181/8181), done.
remote: Compressing objects: 100% (3098/3098), done.
remote: Total 32867 (delta 4945), reused 7469 (delta 4732), pack-reused 24686
Receiving objects: 100% (32867/32867), 128.83 MiB | 30.91 MiB/s, done.
Resolving deltas: 100% (19797/19797), done.

สคริปต์

คุณอาจต้องสร้างสคริปต์บางรายการในโฟลเดอร์ script เพื่อทําให้งานทั่วไปง่ายขึ้น ซึ่งอาจรวมถึงสคริปต์สําหรับงานต่างๆ เช่น การเปิดเครื่อง การสร้าง การเรียกใช้โค้ดโค้ด และสคริปต์สําหรับการตรวจสอบ GitHub CI

ด้านล่างนี้คือตัวอย่างสคริปต์ที่เป็นมาตรฐานสําหรับที่เก็บแพลตฟอร์มส่วนใหญ่ที่มีอยู่

bootstrap

สคริปต์นี้ควรติดตั้งเครื่องมือและแพ็กเกจทั้งหมดที่แพลตฟอร์มฮาร์ดแวร์กําหนด นอกจากนี้ ควรดําเนินการตามสคริปต์บูทสแตนด์ของ openthread เพื่อให้มั่นใจว่าผู้ใช้มีทุกสิ่งที่ต้องการในการสร้างสแต็ก OpenThread

ดูตัวอย่างได้ที่สคริปต์ Boottrap ใน ot-efr32

build

สคริปต์บิลด์ CMake ควรอนุญาตให้ผู้ใช้สร้างสแต็ก OpenThread สําหรับแพลตฟอร์มของคุณ หากที่เก็บของคุณกําหนดตัวอย่างแอปพลิเคชันใดๆ สคริปต์นี้ควรสร้างแอปพลิเคชันเหล่านั้นด้วย สคริปต์นี้ควรมีตัวเลือกการกําหนดค่าระบบพื้นฐาน ซึ่งรวมถึงข้อกําหนดมาโครเฉพาะแพลตฟอร์มนั้นๆ

ดูตัวอย่างได้ในสคริปต์บิลด์ใน ot-efr32

test

สคริปต์ทดสอบอาจเป็นประโยชน์ต่อผู้ใช้ในการทดสอบการเปลี่ยนแปลงโดยใช้การทดสอบที่คุณกําหนดไว้ ซึ่งจะเป็นอะไรก็ได้ที่ง่ายพอๆ กับการเรียกใช้บิลด์ในการตรวจสอบความถูกต้องหรือความซับซ้อนอย่างการเปิดตัวชุดทดสอบหน่วย

ใน ot-efr32 สคริปต์จะเรียกใช้สคริปต์ build สําหรับกระดานที่รองรับบนแพลตฟอร์ม efr32 แต่ละแพลตฟอร์ม

ดูตัวอย่างได้ในสคริปต์ทดสอบใน ot-efr32

make-pretty

สคริปต์นี้จะจัดรูปแบบโค้ด สคริปต์ และไฟล์ Markdown ให้จัดรูปแบบที่สอดคล้องกัน

คุณกําหนดสคริปต์นี้ด้วยตนเองได้ แต่การใช้สคริปต์ make-pretty ที่แพลตฟอร์มที่มีอยู่ใช้อาจเป็นวิธีที่ง่ายที่สุด สคริปต์จะเรียกไปยังสคริปต์รูปแบบของ openthread และช่วยให้รูปแบบในที่เก็บ OpenThread ทั้งหมดสอดคล้องกัน

การกําหนดค่าสคริปต์ Linker

สคริปต์ GNU Linker อธิบายวิธีแมปทุกส่วนในไฟล์อินพุต (ไฟล์ "ออบเจ็กต์" .o ที่สร้างโดย GNU Compiler Collection (GCC)) กับเอาต์พุตสุดท้าย (เช่น .elf) และยังกําหนดตําแหน่งของพื้นที่เก็บข้อมูลแต่ละส่วนของโปรแกรมที่ดําเนินการได้ รวมถึงที่อยู่ของรายการ สคริปต์ Linker เฉพาะแพลตฟอร์มมักจะให้มาพร้อมกับ BSP ของแพลตฟอร์ม

กําหนดค่าเครื่องมือ ld ให้ชี้ไปที่สคริปต์ Linker เฉพาะแพลตฟอร์มโดยใช้ target_link_libraries ในเป้าหมาย CMake ของแพลตฟอร์มใน src/CMakeLists.txt ดังนี้

set(LD_FILE "${CMAKE_CURRENT_SOURCE_DIR}/efr32mg12.ld")

target_link_libraries(openthread-efr32mg12
    PRIVATE
        ot-config
    PUBLIC
        -T${LD_FILE}
        -Wl,--gc-sections -Wl,-Map=$.map
)

โค้ดเริ่มต้นเครื่องมือแบบเชน

รหัสการเริ่มต้นเครื่องมือเชนมักมาพร้อมกับ BSP ของแพลตฟอร์ม โดยทั่วไปโค้ดนี้มีลักษณะดังนี้

  1. ใช้ฟังก์ชันการป้อนข้อมูล (Reset_Handler) ของโปรแกรมที่ดําเนินการได้
  2. กําหนดตารางเวกเตอร์ที่ไม่หยุดชะงัก
  3. เริ่มต้นฮีปและสแต็ก
  4. คัดลอกส่วน .data จากหน่วยความจําที่ไม่เปลี่ยนแปลงไปยัง RAM
  5. ข้ามไปยังฟังก์ชันหลักของแอปพลิเคชันเพื่อเรียกใช้ตรรกะของแอปพลิเคชัน

ต้องรวมโค้ดเริ่มต้น (ซอร์สโค้ดหรือโค้ดประกอบ) ไว้ในไลบรารี openthread-platform-name ของแพลตฟอร์ม มิเช่นนั้น ตัวแปรสําคัญที่ใช้ในสคริปต์ Linker จะอ้างอิงอย่างถูกต้องไม่ได้

  • src/CMakeLists.txt

ตัวอย่าง: startup-gcc.c ใน ot-cc2538 - src/CMakeLists.txt

add_library(openthread-cc2538
    alarm.c
...
    startup-gcc.c
...
    system.c
    logging.c
    uart.c
    $
)