Dual CANbus monitor and instrumentation cluster. Presently tuned for the Nissan Leaf EV.

Dependencies:   SPI_TFTx2_ILI9341 TFT_fonts TOUCH_TFTx2_ILI9341 mbed

Fork of CANary_corrupt by Tick Tock

After adding the LPC1768 platform, import as a program and do not select the "update to latest revision" box

User Guide

Eagle Schematic and Board design

/media/uploads/TickTock/canaryr6.zip

/media/uploads/TickTock/canary_sch.jpg

/media/uploads/TickTock/canaryr6brd.jpg

For LCD Rev 1.01:

/media/uploads/TickTock/lcdsch.jpg

For VCD Rev 2.00:

/media/uploads/TickTock/lcdr2.jpg

Parts List

qtyinstancepart #packagesupplierDescription
1BAT3Vhttp://www.ebay.com/itm/10x-CR2032-SMD-Battery-Holder-for-CR2032-Battery-/180938057979?pt=LH_DefaultDomain_0&hash=item2a20bfa8fbLithium 2032 coin battery holder
4C1-C4ECST1DC106R6032Tantalium capacitor 10uF
3FC1-FC3ZF1-20-01-T-WThttp://www.samtec.com/cable-systems/idc-ffc/ffc/zero-insertion.aspx20 conductor 1mm pitch flex cable connector (optional)
1FJ-20-R-08.00-4http://www.samtec.com/cable-systems/idc-ffc/ffc/zero-insertion.aspx8\" 20 conductor 1mm pitch flex connector, end reversed (optional)
2H1-H4(DON'T populate H1-H4 headers - solder mbed directly)
1H5http://www.ebay.com/itm/221186042943?ssPageName=STRK:MEWNX:IT&_trksid=p3984.m1497.l26491x12 .1\" pitch header (optional)
1H62x6 .1\" pitch header (optional)
2IC1,IC2VP230LMDSOP8http://www.ebay.com/itm/130488665247?ssPageName=STRK:MEWNX:IT&_trksid=p3984.m1497.l2649canbus transciever
1IC3LM1117-5VSOT2235V regulator
5JP*2 pin .1\" jumper header
1mbedLPC1768http://www.ebay.com/itm/200830573509?ssPageName=STRK:MEWNX:IT&_trksid=p3984.m1497.l2649mbed uC
2Q1,Q22N2222SOT23General purpose NPN transistor
1R1R393M120639K resistor
1R2R103M120610K resistor
4R4-R6R102M12061K resistor
1R3R500M120650 Ohm resistor
2TR1-TR5ZJYS81R5-2PL51TG01http://www.digikey.com/product-detail/en/ZJYS81R5-2PL51T-G01/445-2223-1-ND/765232CM Choke
1Z11N5340BGC1702-15http://www.ebay.com/itm/150878122425?ssPageName=STRK:MEWNX:IT&_trksid=p3984.m1497.l26496V, 5W Zener Diode
1Z1DC-DC conveterhttp://www.ebay.com/itm/251142727849?ssPageName=STRK:MEWNX:IT&_trksid=p3984.m1497.l264912V-7V, 3W DC-DC converter
1X1USBhttp://www.ebay.com/itm/New-Vertical-USB-2-0-A-pcb-connector-socket-USB-A-Type-/300553895292?pt=LH_DefaultDomain_0&hash=item45fa687d7cvertical USB connector
2LCD0,LCD1TFThttp://www.mikroe.com/add-on-boards/display/tft-proto/320x240 LCD with touch screen
1E0Enclosurehttp://www.shapeways.com/model/1077799/canary.html?li=user-profile&materialId=63d printed enclosure

Assembly

1) LCD Displays

I found ribbon cable is a nice way to organize the wires to the displays. There are two versions of the display and each must be wired differently. The original project used HW REV. 1.01. For that version, you'll need 12 conductors and I connected them in the following order:

1LED+
2LED-
3RST
4SDI
5WR/SCLK
6CS
7X+
8X-
9Y+
10Y-
11VDD
12GND

If, instead, you have HW REV 2.0, you will need 13 conductors with the following order:

1LED+
2LED-
3RST
4SDI
5RS (SCLK)
6WR (DC)
7CS
8X+
9X-
10Y+
11Y-
12VDD
13GND

First I connected all the GND connections (2 GND & IM0, IM1, IM3 for REV1.01 or 2 GND, RD, & IM0 for REV2.00). Do not connect the bottom GND until you have the ribbon cable connected. After making all the ribbon cable connections (connecting the GND of the ribbon cable to the bottom GND pad), solder the GND bar from the previous step to the back of the bottom GND connection. Finally, make a connection from the back side 3.3V pin to IM2 for REV1.01 or to IM1,IM2,&IM3 for REV2.00. Take a break and repeat for the second display.

Examples of REV1.01 boards:

/media/uploads/TickTock/lcdtop.jpg /media/uploads/TickTock/lcdbot.jpg

Examples of REV2.00:

/media/uploads/TickTock/rev2front.jpg /media/uploads/TickTock/rev2back.jpg

Once the two displays are complete combine all wires except CS0, CS1, X+, X-, Y+, and Y-. Connect X- of the left display to X+ of the right. Similarly connect Y- of the left display to Y+ of the right. Insulate any exposed wires.

2) PCB

Refer to the schematics to place all the components on the board. If you plan to install into the CANary 3D enclosure, DO NOT install the battery holder or the socket for the mbed and, instead, connect two wires to the VB and GND pads nearby. You will have to install the battery holder against the back wall to avoid interfering with the right-hand display and the mbed will have to be directly soldered. I have not found a socket with a low enough profile to fit in the space provided (depth of enclosure is limited by the space behind the center console). Also, I recommend keeping as much lead as possible on the Zener diode (bending it as shown to clear the back wall). Although it is operating well within parameters, the Zener gets quite hot during extended operation and the leads help dissipate the heat and keep it away from the PCB and other components.Update: Several Zeners have failed resulting in damage to some users boards so I recommend using a DC-DC converter instead to bring the 12V down to 7V.

/media/uploads/TickTock/pcbtop.jpg /media/uploads/TickTock/pcbbot.jpg

Once the PCB is populated, solder the LCDs to the PCB. CS0 connects to the right display and CS1 connects to the left. /media/uploads/TickTock/brddis.jpg

Update: The Zener diodes tended to fail after a few months so I am recommending removing them and replacing with a DC-DC converter. This will run cooler and waste less energy, too. To install, remove the left display panel to gain access to the Zener. From there, the Zener can be removed and it's pads used to connect to the DC-DC converter. I recommend setting the output voltage on the bench before installing since the trim pot is tricky to reach once installed. Set it to 7V. The input can be connected to the left pad previously occupied by the zener and the output can connect to the right. GND(-) can be connected to the bottom right pad on the 2x6 header below the flex cable connector. Make sure the GND wire lies flat so it doesn't interfere with the connection of the flex cable. /media/uploads/TickTock/dcdcinst2.jpg

Once soldered in place, the DC-DC converter can easily be mounted to the back wall with double sided tape above the battery holder. /media/uploads/TickTock/dcdcinst3.jpg

3) Testing

1)First step is to buzz out all connections from the LCDs to the pins in the main board
2)Next check the touch screen connections. On the main board, place an Ohm meter across X+ and X-. You should read 700 Ohms. Repeat for Y+ and Y-. Then test the resistance from X+ to Y+. With nothing touching the screens, it should read >100K Ohms and <1K when touching either screen.
3)When all connections are checked, solder in the mbed. Download and install the touch2 program http://mbed.org/users/TickTock/code/touch2/ to test the basic operation of the mbed and touch screens.
tips:
Touch screen is sensitive - excess flux on X+,X-,Y+,Y- connection on mbed can result in flakey operation
If touch is not working, double-check the LCD0_CS and LCD1_CS are not swapped. LCD0_CS must connect to the CS of the LCD that has X- & Y- connected to the mbed. LCD1_CS must connect to the CS of the LCD that has X+ & Y+ connected to the mbed.
4)Once touch2 works, it is time to connect to the OBD connector. I highly recommend double checking all connections from the OBD to the PCB with the cable in place before connecting to the Leaf. Buzz out all the pins in the OBS to make sure none are shorting to each other, Check that the 12V goes to the Zener (and nothing else) and the switched 12V to the resistor divider (and nothing else). Test the ground connection properly connects to ground and nothing else.
5)Once you are confident there are no shorts or wrong connections from the OBD connector, take a deep breath and plug it into your leaf. Touch2 program should come up and function. Unplug and install the latest CANary firmware. If you have the REV2.00 LCD boards, you will need to edit the precompile.h file in the TOUCH_TFTx2_w9341 library and set USE_ILI9341 to 1. Test all features before installing into the enclosure (gids, cellpair, menu system, logging) since installing and removing from the enclosure is a PITA.

/media/uploads/TickTock/pcbdone.jpg /media/uploads/TickTock/functioning.jpg

4) Enclosure

The 3D printer leaves a lot of powder behind - I used a strong spray of water to get it out of all the cracks. The enclosure comes with a rather rough finish. I recommend convincing yourself you like it, then simply lightly sand then paint before assembly. Sanding is very difficult - the nylon is very nicely fused and doesn't want to sand. I tried sandblasting and that didn't work either. I had some limited success with filler and then sanding, but only on the outside - it is too difficult to sand the face. /media/uploads/TickTock/enclosure.jpg

5) Final Assembly

Make sure you are well rested with lots of patience before attempting assembly. It is a puzzle figuring out how to get both displays and the PCB in place. Enclosure was too expensive for me to keep iterating to optimize for assembly. I ended up snipping the thin display posts shorter and using various tools to push the displays into place. Also, some USB connectors are taller than others. If you have one of the taller ones, you will have to deflect the back wall a bit while inserting the PCB (being careful not to bend the housing) to get it to it's opening in the back wall. Do use a screw in the provided post to secure the PCB as USB insertion will otherwise dislodge it.

I added an additional safety line which wraps around the center post to prevent the enclosure from becoming a projectile in the event of an accident. /media/uploads/TickTock/safety.jpg Installed: /media/uploads/TickTock/installed.jpg

Committer:
TickTock
Date:
Sun Feb 03 18:16:53 2013 +0000
Revision:
1:9dcd70c32180
Parent:
FatFileSystem/ff.h@0:1596b8644523
compiles

Who changed what in which revision?

UserRevisionLine numberNew contents of line
TickTock 0:1596b8644523 1 /*--------------------------------------------------------------------------/
TickTock 0:1596b8644523 2 / FatFs - FAT file system module include file R0.06 (C)ChaN, 2008
TickTock 0:1596b8644523 3 /---------------------------------------------------------------------------/
TickTock 0:1596b8644523 4 / FatFs module is an experimenal project to implement FAT file system to
TickTock 0:1596b8644523 5 / cheap microcontrollers. This is a free software and is opened for education,
TickTock 0:1596b8644523 6 / research and development under license policy of following trems.
TickTock 0:1596b8644523 7 /
TickTock 0:1596b8644523 8 / Copyright (C) 2008, ChaN, all right reserved.
TickTock 0:1596b8644523 9 /
TickTock 0:1596b8644523 10 / * The FatFs module is a free software and there is no warranty.
TickTock 0:1596b8644523 11 / * You can use, modify and/or redistribute it for personal, non-profit or
TickTock 0:1596b8644523 12 / commercial use without any restriction under your responsibility.
TickTock 0:1596b8644523 13 / * Redistributions of source code must retain the above copyright notice.
TickTock 0:1596b8644523 14 /
TickTock 0:1596b8644523 15 /---------------------------------------------------------------------------*/
TickTock 0:1596b8644523 16
TickTock 0:1596b8644523 17 #ifndef _FATFS
TickTock 0:1596b8644523 18
TickTock 0:1596b8644523 19 #define _MCU_ENDIAN 2
TickTock 0:1596b8644523 20 /* The _MCU_ENDIAN defines which access method is used to the FAT structure.
TickTock 0:1596b8644523 21 / 1: Enable word access.
TickTock 0:1596b8644523 22 / 2: Disable word access and use byte-by-byte access instead.
TickTock 0:1596b8644523 23 / When the architectural byte order of the MCU is big-endian and/or address
TickTock 0:1596b8644523 24 / miss-aligned access results incorrect behavior, the _MCU_ENDIAN must be set to 2.
TickTock 0:1596b8644523 25 / If it is not the case, it can also be set to 1 for good code efficiency. */
TickTock 0:1596b8644523 26
TickTock 0:1596b8644523 27 #define _FS_READONLY 0
TickTock 0:1596b8644523 28 /* Setting _FS_READONLY to 1 defines read only configuration. This removes
TickTock 0:1596b8644523 29 / writing functions, f_write, f_sync, f_unlink, f_mkdir, f_chmod, f_rename,
TickTock 0:1596b8644523 30 / f_truncate and useless f_getfree. */
TickTock 0:1596b8644523 31
TickTock 0:1596b8644523 32 #define _FS_MINIMIZE 0
TickTock 0:1596b8644523 33 /* The _FS_MINIMIZE option defines minimization level to remove some functions.
TickTock 0:1596b8644523 34 / 0: Full function.
TickTock 0:1596b8644523 35 / 1: f_stat, f_getfree, f_unlink, f_mkdir, f_chmod, f_truncate and f_rename are removed.
TickTock 0:1596b8644523 36 / 2: f_opendir and f_readdir are removed in addition to level 1.
TickTock 0:1596b8644523 37 / 3: f_lseek is removed in addition to level 2. */
TickTock 0:1596b8644523 38
TickTock 0:1596b8644523 39 #define _USE_STRFUNC 0
TickTock 0:1596b8644523 40 /* To enable string functions, set _USE_STRFUNC to 1 or 2. */
TickTock 0:1596b8644523 41
TickTock 0:1596b8644523 42 #define _USE_MKFS 1
TickTock 0:1596b8644523 43 /* When _USE_MKFS is set to 1 and _FS_READONLY is set to 0, f_mkfs function is
TickTock 0:1596b8644523 44 / enabled. */
TickTock 0:1596b8644523 45
TickTock 0:1596b8644523 46 #define _DRIVES 4
TickTock 0:1596b8644523 47 /* Number of logical drives to be used. This affects the size of internal table. */
TickTock 0:1596b8644523 48
TickTock 0:1596b8644523 49 #define _MULTI_PARTITION 0
TickTock 0:1596b8644523 50 /* When _MULTI_PARTITION is set to 0, each logical drive is bound to same
TickTock 0:1596b8644523 51 / physical drive number and can mount only 1st primaly partition. When it is
TickTock 0:1596b8644523 52 / set to 1, each logical drive can mount a partition listed in Drives[]. */
TickTock 0:1596b8644523 53
TickTock 0:1596b8644523 54 #define _USE_FSINFO 0
TickTock 0:1596b8644523 55 /* To enable FSInfo support on FAT32 volume, set _USE_FSINFO to 1. */
TickTock 0:1596b8644523 56
TickTock 0:1596b8644523 57 #define _USE_SJIS 1
TickTock 0:1596b8644523 58 /* When _USE_SJIS is set to 1, Shift-JIS code transparency is enabled, otherwise
TickTock 0:1596b8644523 59 / only US-ASCII(7bit) code can be accepted as file/directory name. */
TickTock 0:1596b8644523 60
TickTock 0:1596b8644523 61 #define _USE_NTFLAG 1
TickTock 0:1596b8644523 62 /* When _USE_NTFLAG is set to 1, upper/lower case of the file name is preserved.
TickTock 0:1596b8644523 63 / Note that the files are always accessed in case insensitive. */
TickTock 0:1596b8644523 64
TickTock 0:1596b8644523 65
TickTock 0:1596b8644523 66 #include "integer.h"
TickTock 0:1596b8644523 67
TickTock 0:1596b8644523 68 #ifdef __cplusplus
TickTock 0:1596b8644523 69 extern "C" {
TickTock 0:1596b8644523 70 #endif
TickTock 0:1596b8644523 71
TickTock 0:1596b8644523 72 /* Definitions corresponds to multiple sector size (not tested) */
TickTock 0:1596b8644523 73 #define S_MAX_SIZ 512U /* Do not change */
TickTock 0:1596b8644523 74 #if S_MAX_SIZ > 512U
TickTock 0:1596b8644523 75 #define SS(fs) ((fs)->s_size)
TickTock 0:1596b8644523 76 #else
TickTock 0:1596b8644523 77 #define SS(fs) 512U
TickTock 0:1596b8644523 78 #endif
TickTock 0:1596b8644523 79
TickTock 0:1596b8644523 80
TickTock 0:1596b8644523 81 /* File system object structure */
TickTock 0:1596b8644523 82 typedef struct _FATFS {
TickTock 0:1596b8644523 83 WORD id; /* File system mount ID */
TickTock 0:1596b8644523 84 WORD n_rootdir; /* Number of root directory entries */
TickTock 0:1596b8644523 85 DWORD winsect; /* Current sector appearing in the win[] */
TickTock 0:1596b8644523 86 DWORD sects_fat; /* Sectors per fat */
TickTock 0:1596b8644523 87 DWORD max_clust; /* Maximum cluster# + 1 */
TickTock 0:1596b8644523 88 DWORD fatbase; /* FAT start sector */
TickTock 0:1596b8644523 89 DWORD dirbase; /* Root directory start sector (cluster# for FAT32) */
TickTock 0:1596b8644523 90 DWORD database; /* Data start sector */
TickTock 0:1596b8644523 91 #if !_FS_READONLY
TickTock 0:1596b8644523 92 DWORD last_clust; /* Last allocated cluster */
TickTock 0:1596b8644523 93 DWORD free_clust; /* Number of free clusters */
TickTock 0:1596b8644523 94 #if _USE_FSINFO
TickTock 0:1596b8644523 95 DWORD fsi_sector; /* fsinfo sector */
TickTock 0:1596b8644523 96 BYTE fsi_flag; /* fsinfo dirty flag (1:must be written back) */
TickTock 0:1596b8644523 97 BYTE pad2;
TickTock 0:1596b8644523 98 #endif
TickTock 0:1596b8644523 99 #endif
TickTock 0:1596b8644523 100 BYTE fs_type; /* FAT sub type */
TickTock 0:1596b8644523 101 BYTE csize; /* Number of sectors per cluster */
TickTock 0:1596b8644523 102 #if S_MAX_SIZ > 512U
TickTock 0:1596b8644523 103 WORD s_size; /* Sector size */
TickTock 0:1596b8644523 104 #endif
TickTock 0:1596b8644523 105 BYTE n_fats; /* Number of FAT copies */
TickTock 0:1596b8644523 106 BYTE drive; /* Physical drive number */
TickTock 0:1596b8644523 107 BYTE winflag; /* win[] dirty flag (1:must be written back) */
TickTock 0:1596b8644523 108 BYTE pad1;
TickTock 0:1596b8644523 109 BYTE win[S_MAX_SIZ]; /* Disk access window for Directory/FAT */
TickTock 0:1596b8644523 110 } FATFS;
TickTock 0:1596b8644523 111
TickTock 0:1596b8644523 112
TickTock 0:1596b8644523 113 /* Directory object structure */
TickTock 0:1596b8644523 114 typedef struct _DIR {
TickTock 0:1596b8644523 115 WORD id; /* Owner file system mount ID */
TickTock 0:1596b8644523 116 WORD index; /* Current index */
TickTock 0:1596b8644523 117 FATFS* fs; /* Pointer to the owner file system object */
TickTock 0:1596b8644523 118 DWORD sclust; /* Start cluster */
TickTock 0:1596b8644523 119 DWORD clust; /* Current cluster */
TickTock 0:1596b8644523 120 DWORD sect; /* Current sector */
TickTock 0:1596b8644523 121 } FATFS_DIR;
TickTock 0:1596b8644523 122
TickTock 0:1596b8644523 123
TickTock 0:1596b8644523 124 /* File object structure */
TickTock 0:1596b8644523 125 typedef struct _FIL {
TickTock 0:1596b8644523 126 WORD id; /* Owner file system mount ID */
TickTock 0:1596b8644523 127 BYTE flag; /* File status flags */
TickTock 0:1596b8644523 128 BYTE csect; /* Sector address in the cluster */
TickTock 0:1596b8644523 129 FATFS* fs; /* Pointer to the owner file system object */
TickTock 0:1596b8644523 130 DWORD fptr; /* File R/W pointer */
TickTock 0:1596b8644523 131 DWORD fsize; /* File size */
TickTock 0:1596b8644523 132 DWORD org_clust; /* File start cluster */
TickTock 0:1596b8644523 133 DWORD curr_clust; /* Current cluster */
TickTock 0:1596b8644523 134 DWORD curr_sect; /* Current sector */
TickTock 0:1596b8644523 135 #if _FS_READONLY == 0
TickTock 0:1596b8644523 136 DWORD dir_sect; /* Sector containing the directory entry */
TickTock 0:1596b8644523 137 BYTE* dir_ptr; /* Ponter to the directory entry in the window */
TickTock 0:1596b8644523 138 #endif
TickTock 0:1596b8644523 139 BYTE buffer[S_MAX_SIZ]; /* File R/W buffer */
TickTock 0:1596b8644523 140 } FIL;
TickTock 0:1596b8644523 141
TickTock 0:1596b8644523 142
TickTock 0:1596b8644523 143 /* File status structure */
TickTock 0:1596b8644523 144 typedef struct _FILINFO {
TickTock 0:1596b8644523 145 DWORD fsize; /* Size */
TickTock 0:1596b8644523 146 WORD fdate; /* Date */
TickTock 0:1596b8644523 147 WORD ftime; /* Time */
TickTock 0:1596b8644523 148 BYTE fattrib; /* Attribute */
TickTock 0:1596b8644523 149 char fname[8+1+3+1]; /* Name (8.3 format) */
TickTock 0:1596b8644523 150 } FILINFO;
TickTock 0:1596b8644523 151
TickTock 0:1596b8644523 152
TickTock 0:1596b8644523 153
TickTock 0:1596b8644523 154 /* Definitions corresponds to multi partition */
TickTock 0:1596b8644523 155
TickTock 0:1596b8644523 156 #if _MULTI_PARTITION != 0 /* Multiple partition cfg */
TickTock 0:1596b8644523 157
TickTock 0:1596b8644523 158 typedef struct _PARTITION {
TickTock 0:1596b8644523 159 BYTE pd; /* Physical drive # (0-255) */
TickTock 0:1596b8644523 160 BYTE pt; /* Partition # (0-3) */
TickTock 0:1596b8644523 161 } PARTITION;
TickTock 0:1596b8644523 162 extern
TickTock 0:1596b8644523 163 const PARTITION Drives[]; /* Logical drive# to physical location conversion table */
TickTock 0:1596b8644523 164 #define LD2PD(drv) (Drives[drv].pd) /* Get physical drive# */
TickTock 0:1596b8644523 165 #define LD2PT(drv) (Drives[drv].pt) /* Get partition# */
TickTock 0:1596b8644523 166
TickTock 0:1596b8644523 167 #else /* Single partition cfg */
TickTock 0:1596b8644523 168
TickTock 0:1596b8644523 169 #define LD2PD(drv) (drv) /* Physical drive# is equal to logical drive# */
TickTock 0:1596b8644523 170 #define LD2PT(drv) 0 /* Always mounts the 1st partition */
TickTock 0:1596b8644523 171
TickTock 0:1596b8644523 172 #endif
TickTock 0:1596b8644523 173
TickTock 0:1596b8644523 174
TickTock 0:1596b8644523 175 /* File function return code (FRESULT) */
TickTock 0:1596b8644523 176
TickTock 0:1596b8644523 177 typedef enum {
TickTock 0:1596b8644523 178 FR_OK = 0, /* 0 */
TickTock 0:1596b8644523 179 FR_NOT_READY, /* 1 */
TickTock 0:1596b8644523 180 FR_NO_FILE, /* 2 */
TickTock 0:1596b8644523 181 FR_NO_PATH, /* 3 */
TickTock 0:1596b8644523 182 FR_INVALID_NAME, /* 4 */
TickTock 0:1596b8644523 183 FR_INVALID_DRIVE, /* 5 */
TickTock 0:1596b8644523 184 FR_DENIED, /* 6 */
TickTock 0:1596b8644523 185 FR_EXIST, /* 7 */
TickTock 0:1596b8644523 186 FR_RW_ERROR, /* 8 */
TickTock 0:1596b8644523 187 FR_WRITE_PROTECTED, /* 9 */
TickTock 0:1596b8644523 188 FR_NOT_ENABLED, /* 10 */
TickTock 0:1596b8644523 189 FR_NO_FILESYSTEM, /* 11 */
TickTock 0:1596b8644523 190 FR_INVALID_OBJECT, /* 12 */
TickTock 0:1596b8644523 191 FR_MKFS_ABORTED /* 13 */
TickTock 0:1596b8644523 192 } FRESULT;
TickTock 0:1596b8644523 193
TickTock 0:1596b8644523 194
TickTock 0:1596b8644523 195
TickTock 0:1596b8644523 196 /*-----------------------------------------------------*/
TickTock 0:1596b8644523 197 /* FatFs module application interface */
TickTock 0:1596b8644523 198
TickTock 0:1596b8644523 199 FRESULT f_mount (BYTE, FATFS*); /* Mount/Unmount a logical drive */
TickTock 0:1596b8644523 200 FRESULT f_open (FIL*, const char*, BYTE); /* Open or create a file */
TickTock 0:1596b8644523 201 FRESULT f_read (FIL*, void*, UINT, UINT*); /* Read data from a file */
TickTock 0:1596b8644523 202 FRESULT f_write (FIL*, const void*, UINT, UINT*); /* Write data to a file */
TickTock 0:1596b8644523 203 FRESULT f_lseek (FIL*, DWORD); /* Move file pointer of a file object */
TickTock 0:1596b8644523 204 FRESULT f_close (FIL*); /* Close an open file object */
TickTock 0:1596b8644523 205 FRESULT f_opendir (FATFS_DIR*, const char*); /* Open an existing directory */
TickTock 0:1596b8644523 206 FRESULT f_readdir (FATFS_DIR*, FILINFO*); /* Read a directory item */
TickTock 0:1596b8644523 207 FRESULT f_stat (const char*, FILINFO*); /* Get file status */
TickTock 0:1596b8644523 208 FRESULT f_getfree (const char*, DWORD*, FATFS**); /* Get number of free clusters on the drive */
TickTock 0:1596b8644523 209 FRESULT f_truncate (FIL*); /* Truncate file */
TickTock 0:1596b8644523 210 FRESULT f_sync (FIL*); /* Flush cached data of a writing file */
TickTock 0:1596b8644523 211 FRESULT f_unlink (const char*); /* Delete an existing file or directory */
TickTock 0:1596b8644523 212 FRESULT f_mkdir (const char*); /* Create a new directory */
TickTock 0:1596b8644523 213 FRESULT f_chmod (const char*, BYTE, BYTE); /* Change file/dir attriburte */
TickTock 0:1596b8644523 214 FRESULT f_utime (const char*, const FILINFO*); /* Change file/dir timestamp */
TickTock 0:1596b8644523 215 FRESULT f_rename (const char*, const char*); /* Rename/Move a file or directory */
TickTock 0:1596b8644523 216 FRESULT f_mkfs (BYTE, BYTE, WORD); /* Create a file system on the drive */
TickTock 0:1596b8644523 217 #if _USE_STRFUNC
TickTock 0:1596b8644523 218 #define feof(fp) ((fp)->fptr == (fp)->fsize)
TickTock 0:1596b8644523 219 #define EOF -1
TickTock 0:1596b8644523 220 int fputc (int, FIL*); /* Put a character to the file */
TickTock 0:1596b8644523 221 int fputs (const char*, FIL*); /* Put a string to the file */
TickTock 0:1596b8644523 222 int fprintf (FIL*, const char*, ...); /* Put a formatted string to the file */
TickTock 0:1596b8644523 223 char* fgets (char*, int, FIL*); /* Get a string from the file */
TickTock 0:1596b8644523 224 #endif
TickTock 0:1596b8644523 225
TickTock 0:1596b8644523 226 /* User defined function to give a current time to fatfs module */
TickTock 0:1596b8644523 227
TickTock 0:1596b8644523 228 DWORD get_fattime (void); /* 31-25: Year(0-127 org.1980), 24-21: Month(1-12), 20-16: Day(1-31) */
TickTock 0:1596b8644523 229 /* 15-11: Hour(0-23), 10-5: Minute(0-59), 4-0: Second(0-29 *2) */
TickTock 0:1596b8644523 230
TickTock 0:1596b8644523 231
TickTock 0:1596b8644523 232
TickTock 0:1596b8644523 233 /* File access control and file status flags (FIL.flag) */
TickTock 0:1596b8644523 234
TickTock 0:1596b8644523 235 #define FA_READ 0x01
TickTock 0:1596b8644523 236 #define FA_OPEN_EXISTING 0x00
TickTock 0:1596b8644523 237 #if _FS_READONLY == 0
TickTock 0:1596b8644523 238 #define FA_WRITE 0x02
TickTock 0:1596b8644523 239 #define FA_CREATE_NEW 0x04
TickTock 0:1596b8644523 240 #define FA_CREATE_ALWAYS 0x08
TickTock 0:1596b8644523 241 #define FA_OPEN_ALWAYS 0x10
TickTock 0:1596b8644523 242 #define FA__WRITTEN 0x20
TickTock 0:1596b8644523 243 #define FA__DIRTY 0x40
TickTock 0:1596b8644523 244 #endif
TickTock 0:1596b8644523 245 #define FA__ERROR 0x80
TickTock 0:1596b8644523 246
TickTock 0:1596b8644523 247
TickTock 0:1596b8644523 248 /* FAT sub type (FATFS.fs_type) */
TickTock 0:1596b8644523 249
TickTock 0:1596b8644523 250 #define FS_FAT12 1
TickTock 0:1596b8644523 251 #define FS_FAT16 2
TickTock 0:1596b8644523 252 #define FS_FAT32 3
TickTock 0:1596b8644523 253
TickTock 0:1596b8644523 254
TickTock 0:1596b8644523 255 /* File attribute bits for directory entry */
TickTock 0:1596b8644523 256
TickTock 0:1596b8644523 257 #define AM_RDO 0x01 /* Read only */
TickTock 0:1596b8644523 258 #define AM_HID 0x02 /* Hidden */
TickTock 0:1596b8644523 259 #define AM_SYS 0x04 /* System */
TickTock 0:1596b8644523 260 #define AM_VOL 0x08 /* Volume label */
TickTock 0:1596b8644523 261 #define AM_LFN 0x0F /* LFN entry */
TickTock 0:1596b8644523 262 #define AM_DIR 0x10 /* Directory */
TickTock 0:1596b8644523 263 #define AM_ARC 0x20 /* Archive */
TickTock 0:1596b8644523 264
TickTock 0:1596b8644523 265
TickTock 0:1596b8644523 266
TickTock 0:1596b8644523 267 /* Offset of FAT structure members */
TickTock 0:1596b8644523 268
TickTock 0:1596b8644523 269 #define BS_jmpBoot 0
TickTock 0:1596b8644523 270 #define BS_OEMName 3
TickTock 0:1596b8644523 271 #define BPB_BytsPerSec 11
TickTock 0:1596b8644523 272 #define BPB_SecPerClus 13
TickTock 0:1596b8644523 273 #define BPB_RsvdSecCnt 14
TickTock 0:1596b8644523 274 #define BPB_NumFATs 16
TickTock 0:1596b8644523 275 #define BPB_RootEntCnt 17
TickTock 0:1596b8644523 276 #define BPB_TotSec16 19
TickTock 0:1596b8644523 277 #define BPB_Media 21
TickTock 0:1596b8644523 278 #define BPB_FATSz16 22
TickTock 0:1596b8644523 279 #define BPB_SecPerTrk 24
TickTock 0:1596b8644523 280 #define BPB_NumHeads 26
TickTock 0:1596b8644523 281 #define BPB_HiddSec 28
TickTock 0:1596b8644523 282 #define BPB_TotSec32 32
TickTock 0:1596b8644523 283 #define BS_55AA 510
TickTock 0:1596b8644523 284
TickTock 0:1596b8644523 285 #define BS_DrvNum 36
TickTock 0:1596b8644523 286 #define BS_BootSig 38
TickTock 0:1596b8644523 287 #define BS_VolID 39
TickTock 0:1596b8644523 288 #define BS_VolLab 43
TickTock 0:1596b8644523 289 #define BS_FilSysType 54
TickTock 0:1596b8644523 290
TickTock 0:1596b8644523 291 #define BPB_FATSz32 36
TickTock 0:1596b8644523 292 #define BPB_ExtFlags 40
TickTock 0:1596b8644523 293 #define BPB_FSVer 42
TickTock 0:1596b8644523 294 #define BPB_RootClus 44
TickTock 0:1596b8644523 295 #define BPB_FSInfo 48
TickTock 0:1596b8644523 296 #define BPB_BkBootSec 50
TickTock 0:1596b8644523 297 #define BS_DrvNum32 64
TickTock 0:1596b8644523 298 #define BS_BootSig32 66
TickTock 0:1596b8644523 299 #define BS_VolID32 67
TickTock 0:1596b8644523 300 #define BS_VolLab32 71
TickTock 0:1596b8644523 301 #define BS_FilSysType32 82
TickTock 0:1596b8644523 302
TickTock 0:1596b8644523 303 #define FSI_LeadSig 0
TickTock 0:1596b8644523 304 #define FSI_StrucSig 484
TickTock 0:1596b8644523 305 #define FSI_Free_Count 488
TickTock 0:1596b8644523 306 #define FSI_Nxt_Free 492
TickTock 0:1596b8644523 307
TickTock 0:1596b8644523 308 #define MBR_Table 446
TickTock 0:1596b8644523 309
TickTock 0:1596b8644523 310 #define DIR_Name 0
TickTock 0:1596b8644523 311 #define DIR_Attr 11
TickTock 0:1596b8644523 312 #define DIR_NTres 12
TickTock 0:1596b8644523 313 #define DIR_CrtTime 14
TickTock 0:1596b8644523 314 #define DIR_CrtDate 16
TickTock 0:1596b8644523 315 #define DIR_FstClusHI 20
TickTock 0:1596b8644523 316 #define DIR_WrtTime 22
TickTock 0:1596b8644523 317 #define DIR_WrtDate 24
TickTock 0:1596b8644523 318 #define DIR_FstClusLO 26
TickTock 0:1596b8644523 319 #define DIR_FileSize 28
TickTock 0:1596b8644523 320
TickTock 0:1596b8644523 321
TickTock 0:1596b8644523 322
TickTock 0:1596b8644523 323 /* Multi-byte word access macros */
TickTock 0:1596b8644523 324
TickTock 0:1596b8644523 325 #if _MCU_ENDIAN == 1 /* Use word access */
TickTock 0:1596b8644523 326 #define LD_WORD(ptr) (WORD)(*(WORD*)(BYTE*)(ptr))
TickTock 0:1596b8644523 327 #define LD_DWORD(ptr) (DWORD)(*(DWORD*)(BYTE*)(ptr))
TickTock 0:1596b8644523 328 #define ST_WORD(ptr,val) *(WORD*)(BYTE*)(ptr)=(WORD)(val)
TickTock 0:1596b8644523 329 #define ST_DWORD(ptr,val) *(DWORD*)(BYTE*)(ptr)=(DWORD)(val)
TickTock 0:1596b8644523 330 #elif _MCU_ENDIAN == 2 /* Use byte-by-byte access */
TickTock 0:1596b8644523 331 #define LD_WORD(ptr) (WORD)(((WORD)*(volatile BYTE*)((ptr)+1)<<8)|(WORD)*(volatile BYTE*)(ptr))
TickTock 0:1596b8644523 332 #define LD_DWORD(ptr) (DWORD)(((DWORD)*(volatile BYTE*)((ptr)+3)<<24)|((DWORD)*(volatile BYTE*)((ptr)+2)<<16)|((WORD)*(volatile BYTE*)((ptr)+1)<<8)|*(volatile BYTE*)(ptr))
TickTock 0:1596b8644523 333 #define ST_WORD(ptr,val) *(volatile BYTE*)(ptr)=(BYTE)(val); *(volatile BYTE*)((ptr)+1)=(BYTE)((WORD)(val)>>8)
TickTock 0:1596b8644523 334 #define ST_DWORD(ptr,val) *(volatile BYTE*)(ptr)=(BYTE)(val); *(volatile BYTE*)((ptr)+1)=(BYTE)((WORD)(val)>>8); *(volatile BYTE*)((ptr)+2)=(BYTE)((DWORD)(val)>>16); *(volatile BYTE*)((ptr)+3)=(BYTE)((DWORD)(val)>>24)
TickTock 0:1596b8644523 335 #else
TickTock 0:1596b8644523 336 #error Do not forget to set _MCU_ENDIAN properly!
TickTock 0:1596b8644523 337 #endif
TickTock 0:1596b8644523 338
TickTock 0:1596b8644523 339 #ifdef __cplusplus
TickTock 0:1596b8644523 340 };
TickTock 0:1596b8644523 341 #endif
TickTock 0:1596b8644523 342
TickTock 0:1596b8644523 343 #define _FATFS
TickTock 0:1596b8644523 344 #endif /* _FATFS */