Skip to content

Add support for Win32 (serial tool only) #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
build/*
test/build
.vscode/*
.vscode/*
CMakeCache.txt
.cache
CMakeFiles/*
20 changes: 19 additions & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
cmake_minimum_required(VERSION 3.5.0)
cmake_minimum_required(VERSION 3.12)

project(MDFU_Tools)

Expand Down Expand Up @@ -36,5 +36,23 @@ include_directories("${KERNEL_HEADERS_DIR}/include")
set_property(GLOBAL PROPERTY C_STANDARD 23)
set_property(GLOBAL PROPERTY C_EXTENSIONS True)

option(WITH_TOOL_I2C "Build with I2C tools" ON)
option(WITH_TOOL_SPI "Build with SPI tools" ON)
option(WITH_TOOL_NETWORK "Build with Network tools" ON)
option(WITH_TOOL_SERIAL "Build with Serial tools" ON)

if (WITH_TOOL_I2C)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we could be more specific with the tool types in case later there are other SPI/I2C/Network tools. I would suggest to name them e.g. LINUX_SPI_SUBSYSTEM, LINUX_I2C_SUBSYSTEM, LINUX_NETWORK.

add_compile_definitions(USE_TOOL_I2C)
endif()
if (WITH_TOOL_SPI)
add_compile_definitions(USE_TOOL_SPI)
endif()
if (WITH_TOOL_NETWORK)
add_compile_definitions(USE_TOOL_NETWORK)
endif()
if (WITH_TOOL_SERIAL)
add_compile_definitions(USE_TOOL_SERIAL)
endif()

add_subdirectory(apps)
add_subdirectory(src)
4 changes: 1 addition & 3 deletions apps/cmdfu/cli_parser.c
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,7 @@ static void print_options(const char *message, char **argv){
char buf[size];
char *pbuf = buf;
for (char **ptr = argv; *ptr != NULL; ptr++){
pbuf = stpcpy(pbuf, *ptr);
*pbuf = ' ';
pbuf++;
pbuf += sprintf(pbuf, "%s ", *ptr);
}
*(pbuf - 1) = '\0'; // Replace the last space with a null terminator
DEBUG("%s %s", message, buf);
Expand Down
1 change: 1 addition & 0 deletions apps/cmdfu/cmdfu.h
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#ifndef CMDFU_H
#define CMDFU_H

#include <stdbool.h>
#include "mdfu/tools/tools.h"

/**
Expand Down
170 changes: 170 additions & 0 deletions include/mdfu/endian.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
// "License": Public Domain
// I, Mathias Panzenböck, place this file hereby into the public domain. Use it at your own risk for whatever you like.
// In case there are jurisdictions that don't support putting things in the public domain you can also consider it to
// be "dual licensed" under the BSD, MIT and Apache licenses, if you want to. This code is trivial anyway. Consider it
// an example on how to get the endian conversion functions on different platforms.

#ifndef PORTABLE_ENDIAN_H__
#define PORTABLE_ENDIAN_H__

#if (defined(_WIN16) || defined(_WIN32) || defined(_WIN64)) && !defined(__WINDOWS__)

# define __WINDOWS__

#endif

#if defined(__linux__) || defined(__CYGWIN__)

# include <endian.h>

#elif defined(__APPLE__)

# include <libkern/OSByteOrder.h>

# define htobe16(x) OSSwapHostToBigInt16(x)
# define htole16(x) OSSwapHostToLittleInt16(x)
# define be16toh(x) OSSwapBigToHostInt16(x)
# define le16toh(x) OSSwapLittleToHostInt16(x)

# define htobe32(x) OSSwapHostToBigInt32(x)
# define htole32(x) OSSwapHostToLittleInt32(x)
# define be32toh(x) OSSwapBigToHostInt32(x)
# define le32toh(x) OSSwapLittleToHostInt32(x)

# define htobe64(x) OSSwapHostToBigInt64(x)
# define htole64(x) OSSwapHostToLittleInt64(x)
# define be64toh(x) OSSwapBigToHostInt64(x)
# define le64toh(x) OSSwapLittleToHostInt64(x)

# define __BYTE_ORDER BYTE_ORDER
# define __BIG_ENDIAN BIG_ENDIAN
# define __LITTLE_ENDIAN LITTLE_ENDIAN
# define __PDP_ENDIAN PDP_ENDIAN

#elif defined(__OpenBSD__)

# include <endian.h>

# define __BYTE_ORDER BYTE_ORDER
# define __BIG_ENDIAN BIG_ENDIAN
# define __LITTLE_ENDIAN LITTLE_ENDIAN
# define __PDP_ENDIAN PDP_ENDIAN

#elif defined(__NetBSD__) || defined(__FreeBSD__) || defined(__DragonFly__)

# include <sys/endian.h>

# define be16toh(x) betoh16(x)
# define le16toh(x) letoh16(x)

# define be32toh(x) betoh32(x)
# define le32toh(x) letoh32(x)

# define be64toh(x) betoh64(x)
# define le64toh(x) letoh64(x)

#elif defined(__WINDOWS__)

# include <winsock2.h>
# ifdef __GNUC__
# include <sys/param.h>
# endif

# if BYTE_ORDER == LITTLE_ENDIAN

# define htobe16(x) htons(x)
# define htole16(x) (x)
# define be16toh(x) ntohs(x)
# define le16toh(x) (x)

# define htobe32(x) htonl(x)
# define htole32(x) (x)
# define be32toh(x) ntohl(x)
# define le32toh(x) (x)

# define htobe64(x) htonll(x)
# define htole64(x) (x)
# define be64toh(x) ntohll(x)
# define le64toh(x) (x)

# elif BYTE_ORDER == BIG_ENDIAN

/* that would be xbox 360 */
# define htobe16(x) (x)
# define htole16(x) __builtin_bswap16(x)
# define be16toh(x) (x)
# define le16toh(x) __builtin_bswap16(x)

# define htobe32(x) (x)
# define htole32(x) __builtin_bswap32(x)
# define be32toh(x) (x)
# define le32toh(x) __builtin_bswap32(x)

# define htobe64(x) (x)
# define htole64(x) __builtin_bswap64(x)
# define be64toh(x) (x)
# define le64toh(x) __builtin_bswap64(x)

# else

# error byte order not supported

# endif

# define __BYTE_ORDER BYTE_ORDER
# define __BIG_ENDIAN BIG_ENDIAN
# define __LITTLE_ENDIAN LITTLE_ENDIAN
# define __PDP_ENDIAN PDP_ENDIAN

#elif defined(__QNXNTO__)

# include <gulliver.h>

# define __LITTLE_ENDIAN 1234
# define __BIG_ENDIAN 4321
# define __PDP_ENDIAN 3412

# if defined(__BIGENDIAN__)

# define __BYTE_ORDER __BIG_ENDIAN

# define htobe16(x) (x)
# define htobe32(x) (x)
# define htobe64(x) (x)

# define htole16(x) ENDIAN_SWAP16(x)
# define htole32(x) ENDIAN_SWAP32(x)
# define htole64(x) ENDIAN_SWAP64(x)

# elif defined(__LITTLEENDIAN__)

# define __BYTE_ORDER __LITTLE_ENDIAN

# define htole16(x) (x)
# define htole32(x) (x)
# define htole64(x) (x)

# define htobe16(x) ENDIAN_SWAP16(x)
# define htobe32(x) ENDIAN_SWAP32(x)
# define htobe64(x) ENDIAN_SWAP64(x)

# else

# error byte order not supported

# endif

# define be16toh(x) ENDIAN_BE16(x)
# define be32toh(x) ENDIAN_BE32(x)
# define be64toh(x) ENDIAN_BE64(x)
# define le16toh(x) ENDIAN_LE16(x)
# define le32toh(x) ENDIAN_LE32(x)
# define le64toh(x) ENDIAN_LE64(x)

#else

# error platform not supported

#endif

#endif
18 changes: 13 additions & 5 deletions include/mdfu/tools/tools.h
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,19 @@ typedef struct {
}tool_t;

typedef enum tool_type {
TOOL_SERIAL = 0,
TOOL_NETWORK = 1,
TOOL_SPIDEV = 2,
TOOL_I2CDEV = 3,
TOOL_NONE = 4
#ifdef USE_TOOL_SERIAL
TOOL_SERIAL,
#endif
#ifdef USE_TOOL_NETWORK
TOOL_NETWORK,
#endif
#ifdef USE_TOOL_SPI
TOOL_SPIDEV,
#endif
#ifdef USE_TOOL_I2C
TOOL_I2CDEV,
#endif
TOOL_NONE
}tool_type_t;

extern const char *tool_names[];
Expand Down
16 changes: 15 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,21 @@ cmake -B build

- MDFU_MAX_COMMAND_DATA_LENGTH: Defines the maximum MDFU command data length that is supported. This must be at least the same size as the MDFU client reported size.
- MDFU_MAX_RESPONSE_DATA_LENGTH: Defines the maximumd MDFU response data length that is supported.
- WITH_TOOL_I2C: Include I2C target device (Linux-only, not supported for Windows targets), default ON.
- WITH_TOOL_SPI: Include SPI target device (Linux-only, not supported for Windows targets), default ON.
- WITH_TOOL_SERIAL: Include serial target device (supported on Linux & Windows targets), default ON.
- WITH_TOOL_NETWORK: Include network target device (Linux-only, not yet supported for Windows targets), default ON.

Creating the build tree and configuring maximum MDFU command data size.
```bash
cmake -B build -D MDFU_MAX_COMMAND_DATA_LENGTH=1024
```

Creating a build for Win32 serial devices only:
```bash
cmake -B build -D WITH_TOOL_I2C=OFF -D WITH_TOOL_SPI=OFF -D WITH_TOOL_NETWORK=OFF
```

## Building

Building by invocing native build tools through cmake
Expand All @@ -29,6 +38,11 @@ cd build
make
```

Build `cmdfu` utility only (needed for Windows build which doesn't yet support tests):
```bash
cmake --build build --target cmdfu
```

## Running the application from the build tree

```bash
Expand Down Expand Up @@ -56,4 +70,4 @@ The source and debian package will be available in the ./build directory.
Build and packaging in one step.
```bash
cmake --build build --target package
```
```
38 changes: 33 additions & 5 deletions src/mac/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,39 @@
if (WITH_TOOL_NETWORK)
set(NETWORK_HEADER "${CMAKE_SOURCE_DIR}/include/mdfu/mac/socket_mac.h")
set(NETWORK_SOURCE "socket_mac.c" "socket_packet_mac.c")
endif()
if (WITH_TOOL_SERIAL)
set(SERIAL_HEADER "${CMAKE_SOURCE_DIR}/include/mdfu/mac/serial_mac.h")
if (WIN32)
set(SPI_SOURCE "serial_mac_win.c")
else()
set(SERIAL_SOURCE "serial_mac.c")
endif()
endif()
if (WITH_TOOL_SPI)
set(SPI_HEADER "${CMAKE_SOURCE_DIR}/include/mdfu/mac/spidev_mac.h")
set(SPI_SOURCE "spidev_mac.c")
endif()
if (WITH_TOOL_I2C)
set(I2C_HEADER "${CMAKE_SOURCE_DIR}/include/mdfu/mac/i2cdev_mac.h")
set(I2C_SOURCE "i2cdev_mac.c")
endif()

set(HEADER_LIST
"${CMAKE_SOURCE_DIR}/include/mdfu/mac/mac.h"
"${CMAKE_SOURCE_DIR}/include/mdfu/mac/socket_mac.h"
"${CMAKE_SOURCE_DIR}/include/mdfu/mac/serial_mac.h"
"${CMAKE_SOURCE_DIR}/include/mdfu/mac/spidev_mac.h"
"${CMAKE_SOURCE_DIR}/include/mdfu/mac/i2cdev_mac.h"
${NETWORK_HEADER}
${SERIAL_HEADER}
${SPI_HEADER}
${I2C_HEADER}
)

set(SOURCE_LIST
${NETWORK_SOURCE}
${SERIAL_SOURCE}
${SPI_SOURCE}
${I2C_SOURCE}
)

add_library(maclib socket_mac.c socket_packet_mac.c serial_mac.c i2cdev_mac.c spidev_mac.c ${HEADER_LIST})
add_library(maclib ${SOURCE_LIST} ${HEADER_LIST})
target_include_directories(maclib PUBLIC "${CMAKE_SOURCE_DIR}/include")
target_include_directories(maclib PUBLIC "${CMAKE_BINARY_DIR}/include")
Loading