immanuelplattner
commented
1 year ago I discovered it gets even worse. The mxc.h includes also the header files led.h and pb.h. So you have to define them also somewhere or use the generic drivers in MaximSDK/Libraries/MiscDrivers/LED and MaximSDK/Libraries/MiscDrivers/PushButton. But that is even more work, because you need to add them in the make file and also you need to define certain global variables.
My current project.mk:
# This file can be used to set build configuration
# variables. These variables are defined in a file called
# "Makefile" that is located next to this one.
# For instructions on how to use this system, see
# https://analog-devices-msdk.github.io/msdk/USERGUIDE/#build-system
#MXC_OPTIMIZE_CFLAGS = -Og
# ^ For example, you can uncomment this line to
# optimize the project for debugging
################################################################################
MXC_OPTIMIZE_CFLAGS = -O2
# Setting the target chip
TARGET = MAX78000
# Since we are working with our custum hardware, we do not load any Maxim board
# specific libraries.
LIB_BOARD = 0
# Where to find the missing BSP source files (included in mxc.h)
VPATH += $(MAXIM_PATH)/Libraries/MiscDrivers/LED
VPATH += $(MAXIM_PATH)/Libraries/MiscDrivers/PushButton
# Where to find the missing BSP header files (include in mxc.h)
IPATH += $(MAXIM_PATH)/Libraries/MiscDrivers/LED
IPATH += $(MAXIM_PATH)/Libraries/MiscDrivers/PushButton
# If enabled, the mic samples used for inference are sent to the serial port
#PROJ_CFLAGS+=-DSEND_MIC_OUT_SERIALMy current *board.h":
/*******************************************************************************
* This file is necessary, because the SDK file
* MaximSDK/Libraries/PeriphDrivers/Include/MAX78000/mxc.h includes a board.h
* file on line 45 and the author did not want to change a header file in the
* SDK.
******************************************************************************/
#ifndef __BOARD_H__
#define __BOARD_H__
#define BOARD_SMARTCARD_V01
#define CONSOLE_UART 0
#define CONSOLE_BAUD 115200
#endif // __BOARD_H__And my current board.c:
#include "board.h"
#include "gpio.h"
// Definition of the LED pins (for MaximSDK/Libraries/MiscDrivers/LED)
const mxc_gpio_cfg_t led_pin[] = {}; // No LEDs on the hardware
const unsigned int num_leds = (sizeof(led_pin) / sizeof(mxc_gpio_cfg_t));
// Definition of the buttons pins (for MaximSDK/Libraries/MiscDrivers/PushButton)
const mxc_gpio_cfg_t pb_pin[] = {}; // No buttons on the hardware
const unsigned int num_pbs = (sizeof(pb_pin) / sizeof(mxc_gpio_cfg_t));Now the project compiles fine. I just think it is a rather big effort when it should have been just LIB_BOARD = 0.
Jake-Carter
Dear MSDK developers,
According to the user guide you can disable the BSP integration entirely. That is exactly what I needed so I set
LIB_BOARD=0in my projects projekt.mk. After that I performed a clean and a build and got the following errors:After I got over my disappointment I had a look at the SDK header file MaximSDK/Libraries/PeriphDrivers/Include/MAX78000/mxc.h:
After digging around in the included led.h and pb.h I propose to change mxc.h so something like this:
That way, one can truly deactivate the BSP in one fell swoop. As it currently is, I am forced to define a header file called board.h somewhere, because it is obviously a bad idea to change a header file in the SDK, which is also used in a number of other projects.
I also take issue with the official approach to custom BSPs as detailed in the user guide. This section instructs the user to create custom BSPs in a certain directory in the SDK. I personally prefer to not touch the SDK at all. Because as soon as you do, you basically have to store the whole changed SDK in your software project. It is also very annoying/difficult to keep track of all the changes you make. Very quickly something falls through the cracks and that can lead to issues down the line. In short: It is a disaster in terms of reproducibility.
That said, I want to say thank you that you even have such instructions. Unfortunately, a lot of SDKs have way worse documentation. They basically force you to browse through the whole file structure and hunt through all the make files and piece it together yourself. So thank you for that.
Regards