##Firmware

The 'firmware' directory contains code for the dev platform(s). Currently that is Pic32, but we will add a new section if and when required.

##Hardware

The main microcontroller is a Microchip PIC32MX795F512L

The project was developed in Mplab-X IDE V2.20 under Linux, but can also be built under Windows & Mac:

https://www.microchip.com/pagehandler/en-us/family/mplabx/

The compiler used was the free version of Microchip's XC32 V1.34:

https://www.microchip.com/pagehandler/en-us/devtools/mplabxc/home.html

USB stack and peripheral support is provided by Microchip Application Library v2013-06-15:

• Linux
  • Install to '/opt/microchip/microchip_solutions_v2013-06-15'
• Windows
  • Install to installer default location
• Mac
  • Install to default location, which will normally be your home directory.

Example setup Linux x64:

mkdir tmp; cd tmp;
#Get Mplab-X
wget https://ww1.microchip.com/downloads/en/DeviceDoc/MPLABX-v2.26-linux-installer.sh
# Get compiler
wget https://ww1.microchip.com/downloads/en/DeviceDoc/xc32-v1.34-full-install-linux-installer.run
# Get USB support
wget https://ww1.microchip.com/downloads/en/softwarelibrary/microchip-libraries-for-applications-v2013-06-15-linux-installer.run
# Install IDE
chmod +x MPLABX-v2.26-linux-installer.sh 
sudo ./MPLABX-v2.26-linux-installer.sh 
64 Bit, check libraries
Check for 32 Bit libraries
Verifying archive integrity... All good.
chmod +x xc32-v1.34-full-install-linux-installer.run 
sudo ./xc32-v1.34-full-install-linux-installer.run
chmod +x microchip-libraries-for-applications-v2013-06-15-linux-installer.run
sudo ./microchip-libraries-for-applications-v2013-06-15-linux-installer.run

When the Bootloader is running the RFIDler appears on the USB as a HID, and waits for new RFIDler firmware to install in Flash memory. There are several ways of entering the Bootloader, see "Loading new Firmware" section below.

USB HID Bootloader is provided by the UBW32 project

For convenience, a copy of the bootloader hex and an MPLAB hex load project is provided in firmware/Pic32/HIDBoot_MX795_Hex_Load.X

The Bootloader client, mphidflash, runs on Linux/Max/Windows and transmits & verifies the new firmware.

https://code.google.com/p/mphidflash/

mphidflash v1.3 has some known bugs where for some ROM binaries programming fails and a verification error is reported.

If you hit this problem check for a newer release of mphidflash. Pre-compiled executables for all platforms are available here

Install packages as above.

Clone this repo to your local hard disk.

1. Start MPLAB X IDE
2. Choose File/Open Project/
3. Browse to RFIDler.X and click 'Open Project'

If you are running Windows, you will need to change the default Linux library to the local Windows version:

1. In the 'Projects' window, expand RFIDler/Libraries
2. Highlight the only entry (/opt/microchip/xc32/v1.34/pic32mx/lib/libmchp_peripheral_32MX795F512L.a) and right-click
3. Select 'Remove'
4. Copy the libmchp_peripheral_32MX795F512L.a file: from your local XC32 installation (normally 'Program Files (x86)/Microchip/xc32') and drill down to v1.34/pic32mx/lib/ to your RFIDler.X project directory.
5. Select 'Libraries' and right-click
6. Select 'Add Library/Object file'
7. Browse to your RFIDler.X project and select libmchp_peripheral_32MX795F512L.a

(There are bugs in MPLAB X and GNU make such that paths to libraries containing spaces are not always processed correctly, and the default install path on Windows contains spaces so making the copy is the simplest solution.)

If you are running Mac OS X, you will need to change the default Linux library to the local Mac version:

1. In the 'Projects' window, expand RFIDler/Libraries
2. Highlight the only entry (/opt/microchip/xc32/v1.34/pic32mx/lib/libmchp_peripheral_32MX795F512L.a) and ctrl-click
3. Select 'Remove'
4. Select 'Libraries' and ctrl-click
5. Select 'Add Library/Object file'
6. Browse to your xc32 installation directory (default is /Applications/microchip/xc32) and drill down to v1.34/pic32mx/lib/ select libmchp_peripheral_32MX795F512L.a
7. In the projects window, highlight 'RFIDler' and ctl-click
8. Select 'Properties'
9. For both 'Conf: [default]' and 'Conf: [debug]', perform the following steps:
10. Select 'xc32-gcc'
11. In the 'Option categories' pulldown menu, select 'Preprocessing and messages'
12. Double-click on the 'Include directories' window
13. Edit the two 'microchip_solutions_v2013-06-15' entries, such that they point at your local installation (prepending '../../../../..' should suffice if you installed to the default location, and your project is also in the default location for projects)
14. Edit the '/opt/microchip/xc32' entry, and substitute '/Applications/' for '/opt/'
15. Select 'Run/Clean and Build Main Project'

The device can be powered via the USB port, and, if connected to a PC, will provide a management CLI/API via USB-Serial CDC at 115200 baud (8 bit, No Parity, 1 Stop Bit, No Handshaking/Flow Control).

The CLI/API is also accessible via 3.3v or 5v UART on pins RF4 (UART2 RX) and RF5 (UART2 TX)

When you connect with USB for the first time, you may need to perform some configuration steps:

Create a rule file for UDEV to allow non-root access to the file, and also disable modem manager access. An appropriate file can be found in the MPLAB project under the "Linux Support" tab. Copy this file to /etc/udev/rules.d and run sudo udevadm control --reload-rules

Windows drivers can be found in the 'Windows Driver' tab of the MPLAB project

To connect, any serial terminal emulator should work, but we recommend:

• Linux: minicom (sudo apt-get install minicom)
• Windows: PuTTY
• Mac OS X: SerialTools (free from the App Store)

Example linux connection:

minicom -D /dev/ttyACM1 -b 115200 

Once connected, hit <ENTER> to see the HELP screen and switch to CLI mode, or send commands to remain in API mode.

In API mode, all commands are as per CLI mode, and will be ACK'd by a single '.' or NACK'd by '!' if command fails or '?' if it is not recognised. Other output is command dependant.

Enter bootloader mode

• either from the menu (BL)
• or by holding down button BOOTLOADER while simultaneously
  • plugging in the USB cable
  • or pressing the 'RESET' button.

LED6 and LED5 will show stable orange light to confirm bootloader mode has been entered.

#~/tools/mphidflash-1.6/binaries/mphidflash-1.6-linux-64 -r -w firmware/Pic32/RFIDler.X/dist/debug/production/RFIDler.X.production.hex 
USB HID device found: 503808 bytes free
Device family: PIC32

Erasing...
Writing hex file 'RFIDler.X.production.hex':......[...removed for brevity...]
Verifying:.... [...removed for brevity...]
Resetting device...

You can verify the flashing via version

*RFIDler> version
0071-beta

dmesg should show the following:

generic-usb 0003:04D8:003C.0003: hiddev0,hidraw1: USB HID v1.11 Device [Microchip Technology Inc. USB HID Bootloader] on usb-0000:00:1d.0-1.1.2.1/input0

To flash the code, cd to the top of the repo and run:

	mphidflash -r -w firmware/Pic32/RFIDler.X/dist/default/production/RFIDler.X.production.hex

The device will be programmed and will then reboot. dmesg should show:

usb 2-1.1.2.1: USB disconnect, device number 19
usb 2-1.1.2.1: new full speed USB device number 20 using ehci_hcd
cdc_acm 2-1.1.2.1:1.0: This device cannot do calls on its own. It is not a modem.
cdc_acm 2-1.1.2.1:1.0: ttyACM3: USB ACM device

???

Option 1, v1.6:

curl https://mphidflash.googlecode.com/svn/trunk/dist/mphidflash-1.6-src.tar.gz > mphidflash1-6.tar.gz
mkdir mphidflash1-6
tar -zxvf mphidflash1-6.tar.gz -C mphidflash1-6
cd mphidflash1-6
mkdir binaries
sudo make install64

Option 2, latest:

svn checkout https://mphidflash.googlecode.com/svn/trunk/ mphidflash
cd mphidflash
sudo make install64

cd #RFIDler repo
mphidflash -r -w firmware/Pic32/RFIDler.X/dist/debug/production/RFIDler.X.production.hex