Skip to content

Commit 2b38eb3

Browse files
sandeepmistrysandeepmistry
committed
Add support for updating sketches from an SD card
Via 2nd stage boot code that checks SD card for UPDATE.bin
1 parent 7bd2eca commit 2b38eb3

File tree

16 files changed

+3758
-3
lines changed

16 files changed

+3758
-3
lines changed

‎cores/arduino/SERCOM.cpp‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -240,13 +240,13 @@ void SERCOM::enableSPI()
240240

241241
void SERCOM::disableSPI()
242242
{
243-
//Setting the enable bit to 0
244-
sercom->SPI.CTRLA.bit.ENABLE = 0;
245-
246243
while(sercom->SPI.SYNCBUSY.bit.ENABLE)
247244
{
248245
//Waiting then enable bit from SYNCBUSY is equal to 0;
249246
}
247+
248+
//Setting the enable bit to 0
249+
sercom->SPI.CTRLA.bit.ENABLE = 0;
250250
}
251251

252252
void SERCOM::setDataOrderSPI(SercomDataOrder dataOrder)

‎extras/package_index.json.Hourly.template‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,11 @@
4848
"packager": "arduino",
4949
"name": "CMSIS-Atmel",
5050
"version": "1.0.0"
51+
},
52+
{
53+
"packager": "arduino",
54+
"name": "arduinoOTA",
55+
"version": "1.1.0"
5156
}
5257
]
5358
}

‎extras/package_index.json.PR.template‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,11 @@
4848
"packager": "arduino",
4949
"name": "CMSIS-Atmel",
5050
"version": "1.0.0"
51+
},
52+
{
53+
"packager": "arduino",
54+
"name": "arduinoOTA",
55+
"version": "1.1.0"
5156
}
5257
]
5358
}

‎libraries/OTA/extras/OTA_SD/OTA_SD.ino‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
#include <SD.h>
2+
#include <FlashStorage.h>
3+
4+
#define OTA_START 0x2000
5+
#define OTA_SIZE 0x4000
6+
7+
#define SKETCH_START (uint32_t*)(OTA_START + OTA_SIZE)
8+
9+
#ifndef SDCARD_SS_PIN
10+
#define SDCARD_SS_PIN 4
11+
#endif
12+
13+
#define UPDATE_FILE "UPDATE.BIN"
14+
15+
FlashClass flash;
16+
17+
// Initialize C library
18+
extern "C" void __libc_init_array(void);
19+
20+
int main() {
21+
init();
22+
23+
__libc_init_array();
24+
25+
delay(1);
26+
27+
if (SD.begin(SDCARD_SS_PIN) && SD.exists(UPDATE_FILE)) {
28+
File updateFile = SD.open(UPDATE_FILE);
29+
uint32_t updateSize = updateFile.size();
30+
bool updateFlashed = false;
31+
32+
if (updateSize > OTA_SIZE) {
33+
// skip the OTA section
34+
updateFile.seek(OTA_SIZE);
35+
updateSize -= OTA_SIZE;
36+
37+
uint32_t flashAddress = (uint32_t)SKETCH_START;
38+
39+
// erase the pages
40+
flash.erase((void*)flashAddress, updateSize);
41+
42+
uint8_t buffer[512];
43+
44+
// write the pages
45+
for (uint32_t i = 0; i < updateSize; i += sizeof(buffer)) {
46+
updateFile.read(buffer, sizeof(buffer));
47+
48+
flash.write((void*)flashAddress, buffer, sizeof(buffer));
49+
50+
flashAddress += sizeof(buffer);
51+
}
52+
53+
updateFlashed = true;
54+
}
55+
56+
updateFile.close();
57+
58+
if (updateFlashed) {
59+
SD.remove(UPDATE_FILE);
60+
}
61+
}
62+
63+
// jump to the sketch
64+
__set_MSP(*SKETCH_START);
65+
66+
//Reset vector table address
67+
SCB->VTOR = ((uint32_t)(SKETCH_START) & SCB_VTOR_TBLOFF_Msk);
68+
69+
// address of Reset_Handler is written by the linker at the beginning of the .text section (see linker script)
70+
uint32_t resetHandlerAddress = (uint32_t) * (SKETCH_START + 1);
71+
// jump to reset handler
72+
asm("bx %0"::"r"(resetHandlerAddress));
73+
}
74+

‎libraries/OTA/extras/OTA_SD/build.sh‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
#!/bin/sh -x
2+
3+
ARDUINO=arduino
4+
SKETCH_NAME="OTA_SD.ino"
5+
SKETCH="$PWD/$SKETCH_NAME"
6+
BUILD_PATH="$PWD/build"
7+
OUTPUT_PATH="../../src/boot"
8+
9+
if [[ "$OSTYPE" == "darwin"* ]]; then
10+
ARDUINO="/Applications/Arduino.app/Contents/MacOS/Arduino"
11+
fi
12+
13+
buildOTASketch() {
14+
BOARD=$1
15+
DESTINATION=$2
16+
17+
$ARDUINO --verify --board $BOARD --preserve-temp-files --pref build.path="$BUILD_PATH" $SKETCH
18+
cat "$BUILD_PATH/$SKETCH_NAME.bin" | xxd -i > $DESTINATION
19+
rm -rf "$BUILD_PATH"
20+
}
21+
22+
mkdir -p "$OUTPUT_PATH"
23+
24+
buildOTASketch "arduino:samd:arduino_zero_edbg" "$OUTPUT_PATH/zero.h"
25+
buildOTASketch "arduino:samd:mkr1000" "$OUTPUT_PATH/mkr1000.h"
26+
buildOTASketch "arduino:samd:mkrzero" "$OUTPUT_PATH/mkrzero.h"

‎libraries/OTA/keywords.txt‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
#######################################
2+
# Syntax Coloring Map For OTA
3+
#######################################
4+
5+
#######################################
6+
# Datatypes (KEYWORD1)
7+
#######################################
8+
9+
OTA KEYWORD1
10+
11+
#######################################
12+
# Methods and Functions (KEYWORD2)
13+
#######################################
14+
15+
reset KEYWORD2
16+
17+
#######################################
18+
# Constants (LITERAL1)
19+
#######################################

‎libraries/OTA/library.properties‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name=OTA
2+
version=1.0.0
3+
author=Arduino
4+
maintainer=Arduino <info@arduino.cc>
5+
sentence=Update sketches on your board without USB
6+
paragraph=Requires an SD card
7+
category=Other
8+
url=http://www.arduino.cc/en/Reference/OTA
9+
architectures=samd

‎libraries/OTA/src/OTA.cpp‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
/*
2+
Copyright (c) 2016 Arduino LLC. All right reserved.
3+
4+
This library is free software; you can redistribute it and/or
5+
modify it under the terms of the GNU Lesser General Public
6+
License as published by the Free Software Foundation; either
7+
version 2.1 of the License, or (at your option) any later version.
8+
9+
This library is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12+
See the GNU Lesser General Public License for more details.
13+
14+
You should have received a copy of the GNU Lesser General Public
15+
License along with this library; if not, write to the Free Software
16+
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17+
*/
18+
19+
#include <Arduino.h>
20+
21+
#include "OTA.h"
22+
23+
__attribute__ ((section(".ota_boot")))
24+
unsigned char otaBoot[0x4000] = {
25+
#if defined(ARDUINO_SAMD_ZERO)
26+
#include "boot/zero.h"
27+
#elif defined(ARDUINO_SAMD_MKR1000)
28+
#include "boot/mkr1000.h"
29+
#elif defined(ARDUINO_SAMD_MKRZERO)
30+
#include "boot/mkrzero.h"
31+
#else
32+
#error "Unsupported board!"
33+
#endif
34+
};
35+
36+
OTAClass::OTAClass() {
37+
}
38+
39+
void OTAClass::reset() {
40+
// Reset the device
41+
NVIC_SystemReset() ;
42+
43+
while (true);
44+
}
45+
46+
OTAClass OTA;

‎libraries/OTA/src/OTA.h‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
/*
2+
Copyright (c) 2016 Arduino LLC. All right reserved.
3+
4+
This library is free software; you can redistribute it and/or
5+
modify it under the terms of the GNU Lesser General Public
6+
License as published by the Free Software Foundation; either
7+
version 2.1 of the License, or (at your option) any later version.
8+
9+
This library is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
12+
See the GNU Lesser General Public License for more details.
13+
14+
You should have received a copy of the GNU Lesser General Public
15+
License along with this library; if not, write to the Free Software
16+
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17+
*/
18+
19+
#ifndef _OTA_H_INCLUDED
20+
#define _OTA_H_INCLUDED
21+
22+
class OTAClass {
23+
public:
24+
OTAClass();
25+
26+
void reset();
27+
};
28+
29+
extern OTAClass OTA;
30+
31+
#endif

0 commit comments

Comments
 (0)