PD Buddy Sink Firmware
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Clara Hobbs dcb00f4f39 Add boot command to jump to the bootloader 4 years ago
ChibiOS @ ad728cc9bc Update to ChibiOS 16.1.9 4 years ago
boards/PD_BUDDY_SINK Add boot command to jump to the bootloader 4 years ago
docs Minor documentation fixes 4 years ago
ld Compile firmware for STM32F072x8 instead of xB 5 years ago
lib Add support for resistance-derived current 4 years ago
src Add boot command to jump to the bootloader 4 years ago
.gitignore Added a simple LED blinking firmware 5 years ago
.gitmodules Added LICENSE (GPLv3) and ChibiOS submodule 5 years ago
LICENSE Added LICENSE (GPLv3) and ChibiOS submodule 5 years ago
Makefile Add boot command to jump to the bootloader 4 years ago
README.md Update feature list in README 4 years ago
chconf.h Update copyright notices for 2018 4 years ago
halconf.h Update copyright notices for 2018 4 years ago
mcuconf.h Update copyright notices for 2018 4 years ago
pdb_conf.h Update copyright notices for 2018 4 years ago

README.md

PD Buddy Sink Firmware

This is the firmware for the PD Buddy project. Currently, this specifically means the PD Buddy Sink. The firmware is considered stable, and supports the most common use cases for the device.

Features

  • Two boot modes, Setup and Sink, selected by the Setup button’s state at startup.
  • Sink mode implements a simple USB Power Delivery sink, aiming for full compliance with the USB Power Delivery Specification, Revision 2.0, Version 1.3, and with Revision 3.0, Version 1.1.
  • Requests the configured voltage and current if available, or a safe, low power request otherwise.
  • Provides power on the output connector only when an explicit contract is in place for the configured voltage and current.
  • Optional GiveBack support allows power supplies to temporarily remove power from the PD Buddy Sink if necessary.
  • Requests can be made from programmable power supplies, allowing voltages to be requested at 20 mV increments from a wide range (up to 3-21 V).
  • Configuring a voltage range provides a fallback if the preferred voltage is unavailable.
  • The amount of current the device requests can be set as a power or a resistance, as well as a current. These values are taken as constant over the configured voltage range.
  • Setup mode implements a USB CDC-ACM command-line interface allowing configuration to be loaded from and stored in flash.
  • Setup mode allows real-time renegotiation of voltage and current, complete with the ability to control whether the output is enabled or disabled.
  • User can easily read a power supply’s advertised capabilities while in Setup mode.

Prerequisites

To compile the firmware, you must first install the GNU ARM Embedded Toolchain. Details of its installation is beyond the scope of this README. Once the toolchain is installed, clone this repository with:

$ git clone --recursive http://git.clayhobbs.com/pd-buddy/pd-buddy-firmware.git

This will give you a complete copy of the repository, including the ChibiOS submodule.

You will also need to install some program to flash the firmware. The simplest option is dfu-util, as it requires no extra hardware (though either the Boot switch must be installed or two pads must be bridged). If you prefer to use SWD, you could also use stlink or OpenOCD.

Compiling

With all the dependencies installed, the firmware can be compiled as follows:

$ cd pd-buddy-firmware
$ make

This compiles the firmware to build/pd-buddy-firmware.{bin,elf}.

Flashing

The firmware can be flashed in any number of ways, including but not limited to the following:

dfu-util

Set the Boot switch (SW1) on the PD Buddy Sink to the position not marked on the silkscreen to set the device to DFU mode. If your Sink doesn’t have a Boot switch installed, you can simply bridge the two pads of SW1 circled in this image with a blob of solder to achieve the same effect. Once the Sink is set to DFU mode, plug it into your computer. Flash the firmware with:

$ dfu-util -a 0 -s 0x08000000:leave -D build/pd-buddy-firmware.bin

Don’t forget to set the switch back to normal mode (or remove the solder blob) after unplugging the device.

stlink

If you have an ST-LINK/V2, you can use it to flash the firmware via SWD as follows:

$ st-flash write build/pd-buddy-firmware.bin 0x8000000

OpenOCD

OpenOCD can also be used to flash the firmware. If your debug probe is an ST-LINK/V2, you can easily do this as follows:

$ make flash-openocd-stlink

Usage

After first flashing the PD Buddy Sink, the device has no configuration. To configure it, plug it into your computer while holding the “Setup” button. The LED should blink once per second to indicate that the device is in configuration mode. There are then two ways to configure the Sink: a serial terminal, or the configuration GUI.

Configuration with the Serial Terminal

Connect to the PD Buddy Sink with your favorite serial console program, such as GNU Screen, Minicom, or PuTTY. Press Enter, and you should be greeted with a PDBS) prompt. The help command gives brief summaries of each of the available commands.

For example, to configure the PD Buddy Sink to request 2.25 A at 20 V, run the following commands:

PDBS) set_v 20000
PDBS) set_i 2250
PDBS) write

When write is run, the chosen settings are written to flash. You can then simply disconnect the Sink from your computer.

For more information about the serial console configuration interface, refer to the full documentation.

Configuration with the GUI

The Sink can also be configured by the PD Buddy Configuration GUI. For more information, see that repository’s README.

Using the configured PD Buddy Sink

Once the Sink has been configured, just plug it into your USB PD power supply. If the supply is capable of putting out the configured current at the configured voltage, the Sink will negotiate it, then turn on its output and blink the LED three times to indicate success. If the supply cannot output enough power, the Sink will turn its LED on solid to indicate failure, and leave its output turned off.