9. Tataouine SDK

• 9.1. Dependencies
  • 9.1.1. To fetch and to manage the project
    • 9.1.1.1. Repo
    • 9.1.1.2. Git
  • 9.1.2. To compile the firmware
    • 9.1.2.1. Perl
    • 9.1.2.2. A Kconfig parser
    • 9.1.2.3. GNU make
    • 9.1.2.4. C cross-compiler for ARMv7-m
    • 9.1.2.5. AdaCore Ada/SPARK
    • 9.1.2.6. Python-IntelHex
  • 9.1.3. To flash the firmware on the target board
  • 9.1.4. To compile the documentation
  • 9.1.5. Cryptographic tools
  • 9.1.6. To compile the Java applets
• 9.2. Downloading the project with repo
  • 9.2.1. Initialize the SDK
• 9.3. External dependencies
  • 9.3.1. libecc: an elliptic curves cryptography library
  • 9.3.2. SecAESSTM32: a masked AES implementation resilient against SCA
  • 9.3.3. ant-javacard and GlobalPlatformPro: a cross-platform Javacard framework
• 9.4. Configuration
  • 9.4.1. General architecture
• 9.5. Building a new firmware
  • 9.5.1. Pre-requisites
  • 9.5.2. Fetch the project files
  • 9.5.3. Set the environment
  • 9.5.4. Configure the target
  • 9.5.5. Build the firmware
  • 9.5.6. Build the applets
    • 9.5.6.1. Install extra-dependencies
    • 9.5.6.2. Compile the applets
    • 9.5.6.3. Sign and encrypt the firmware
  • 9.5.7. Build the documentation
• 9.6. Flashing a new firmware
  • 9.6.1. Connect the board to the host
  • 9.6.2. Connect OpenOCD to the board
  • 9.6.3. Flashing the device
    • 9.6.3.1. Using the telnet client
    • 9.6.3.2. Using OpenOCD
    • 9.6.3.3. Using GDB
  • 9.6.4. Other ways
• 9.7. Production mode
  • 9.7.1. About the protections to activate in production mode
  • 9.7.2. Lock the platform JTAG/SWD
  • 9.7.3. Activate bootloader RDP2 detection
  • 9.7.4. Lock the JavaCard GlobalPlatform tokens
  • 9.7.5. Mute the debug UART
• 9.8. Debugging the project
  • 9.8.1. Activating the debug
    • 9.8.1.1. Configuring for debugging
    • 9.8.1.2. WooKey serial console
  • 9.8.2. Debugging userspace drivers and applications
  • 9.8.3. Using Minicom and GDB
• 9.9. Creating a new driver
  • 9.9.1. Driver source directories
    • 9.9.1.1. Sources integration
  • 9.9.2. Build mechanism
    • 9.9.2.1. Driver’s Makefile
    • 9.9.2.2. Driver’s build directory
    • 9.9.2.3. Configuring the driver
    • 9.9.2.4. Integrating your driver to the SDK
  • 9.9.3. Interacting with devices
    • 9.9.3.1. Getting device information
    • 9.9.3.2. Declaring the device
• 9.10. Creating a new library
  • 9.10.1. Library source directory
    • 9.10.1.1. Sources integration
  • 9.10.2. Library build mechanism
    • 9.10.2.1. Library’s Makefile
    • 9.10.2.2. Library’s build directory
    • 9.10.2.3. Configuring the library
    • 9.10.2.4. Integrating your library to the SDK
• 9.11. Creating a new application
  • 9.11.1. What is a WooKey application?
  • 9.11.2. The application source directory structure
  • 9.11.3. Writing your first basic application
    • 9.11.3.1. The application Makefile
    • 9.11.3.2. The application Kconfig
  • 9.11.4. Integrating your application to the Tataouine SDK
• 9.12. Internals
  • 9.12.1. Global Makefile hierarchy
  • 9.12.2. Integrating the Configuration set in Kconfig
  • 9.12.3. The pretty-printing build system
  • 9.12.4. Makefile.objs and configuration
• 9.13. Layout and portability
  • 9.13.1. Managing the portability
    • 9.13.1.1. Handling heterogeneous boards
  • 9.13.2. Drivers layout
    • 9.13.2.1. Generated devinfo structure
    • 9.13.2.2. Using the generated data

9.14. Tataouine directories

Tataouine contains the following main directories:

Directory	Purpose
kernel	the EwoK microkernel
drivers	Userspace drivers of various hardware IP
libs	Userspace libraries
loader	Platform bootloader