search

qmk / qmk_firmware

Open-source keyboard firmware for Atmel AVR and Arm USB families
https://qmk.fm
GNU General Public License v2.0
17.8k stars 38.15k forks source link

Unifying the make commands to upload the firmware #481

Closed fredizzimo closed 8 years ago

fredizzimo commented 8 years ago

Currently you have to run different make commands for different keyboards, in order to upload the firmware.

I think we have at least the following

  1. dfu - which runs dfu-program
  2. teensy - which runs teensy-loader-cli
  3. program - which doesn't seem to be used anymore, but used to run avrdude
  4. dfu-util - which runs dfu-util (this is new, and used for programming the Infinity Ergodox)

All of these are of course needed, but we could have the keyboard makefile specify which one to use, and have a single command to be run for all of them. We could even leave the original commands in place and add a new one for that common command.

jackhumbert commented 8 years ago

I'm a fan of that! I'm working on the avrdude programming one right now, too.

The blanket one could be make pgm, and something like PROGRAMMER = dfu in the Makefile. It would have the same overriding capabilities (from command line and subprojects) via something like make pgm=dfu.

Renaming program to avrdude makes sense, I think

algernon commented 8 years ago

You can even have all of these, as is, no PROGRAMMER needed, and have a pgm target depend on the appropriate program target. So the ErgoDox EZ Makefile would have something like this:

pgm: teensy

And then have a .PHONY: pgm in the main makefile, for good measures.

Pros: minimal changes, and allows the real target to be as complex as need be. Cons: all keyboard makefiles need to be modified (but that's the case anyway)

fredizzimo commented 8 years ago

The suggestion @algernon, proposed is close to what I had in mind. That would allow you to write make pgm for the keyboard default programmer, and make dfu-util for example if you want to override the programmer.

All keyboards would not necessarily have to be modified, but in that case they would just not support the pgm target, you would have to use the specific one instead.

jackhumbert commented 8 years ago

That's perfect! I'm not sure why I suggested the make pgm=dfu - it's obvious to just keep the make dfu functionality :)

algernon commented 8 years ago

Mmmmm.. why was this closed? AFAIK, it's not done yet, or is it?