From 2f3cf2887e114b534cc6d6afdd9000af5544bc87 Mon Sep 17 00:00:00 2001 From: WestfW Date: Wed, 30 Sep 2020 01:29:32 -0700 Subject: [PATCH] rename some of the test_* examples to demo_* to reflect that they're closer to actual examples, as opposed to some of the other test_* code, which is more like optiboot devlopment testing. add a readme file to the examples directory. --- .../demo_dospm.ino} | 0 .../{test_dospm => demo_dospm}/optiboot.h | 0 optiboot/examples/readme.md | 29 +++++++++++++++++++ 3 files changed, 29 insertions(+) rename optiboot/examples/{test_dospm/test_dospm.ino => demo_dospm/demo_dospm.ino} (100%) rename optiboot/examples/{test_dospm => demo_dospm}/optiboot.h (100%) create mode 100644 optiboot/examples/readme.md diff --git a/optiboot/examples/test_dospm/test_dospm.ino b/optiboot/examples/demo_dospm/demo_dospm.ino similarity index 100% rename from optiboot/examples/test_dospm/test_dospm.ino rename to optiboot/examples/demo_dospm/demo_dospm.ino diff --git a/optiboot/examples/test_dospm/optiboot.h b/optiboot/examples/demo_dospm/optiboot.h similarity index 100% rename from optiboot/examples/test_dospm/optiboot.h rename to optiboot/examples/demo_dospm/optiboot.h diff --git a/optiboot/examples/readme.md b/optiboot/examples/readme.md new file mode 100644 index 0000000..60208f4 --- /dev/null +++ b/optiboot/examples/readme.md @@ -0,0 +1,29 @@ +## "Examples." + +In general, **test_xxx** is a test program for checking some optiboot functionality, while **demo_xxx** is an example of how a user might use an optiboot feature. + +---- +---- + +### chaucer* + +"big" sketches for testing behavior as sketch sizes get closer to the flash capacity of chips. Especially, "bigger than the old bootloader" and "more than 64k". + +---- + +### demo_reset +Shows out to figure out the reset cause from an application. Since the bootloaders need to fiddle with the normal registers that provide this information, there need to be some extra effort to tell what the original reset cause was. + +---- + +### demo_dospm +Demonstration of an application writing to PROGMEM data arrays using the **do_spm()** or **do_nvmctrl()** features of v8+ optiboot and optiboot_x. + +This demo uses the "higher level" macros from Marek Wodzinsk's "optiboot.h", and so works with both older and new AVRs. + +---- + +### test_nvmctrl +Try out the nvmctrl features of the Mega0 and xTiny chips with optiboot.x +This is rather bare-bones and requires knowledge of the nvctrl "peripheral" +