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 Jul 28 05:32:17 2013 +0000
Revision:
137:70853cf5a30f
Parent:
USBHostLite/usbhost_ms.c@109:3e6f0e8fca0d
Added update if screen touched on power; Fixed hang on immediate USB access

Who changed what in which revision?

UserRevisionLine numberNew contents of line
TickTock 109:3e6f0e8fca0d 1 /*
TickTock 109:3e6f0e8fca0d 2 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 3 * NXP USB Host Stack
TickTock 109:3e6f0e8fca0d 4 *
TickTock 109:3e6f0e8fca0d 5 * (c) Copyright 2008, NXP SemiConductors
TickTock 109:3e6f0e8fca0d 6 * (c) Copyright 2008, OnChip Technologies LLC
TickTock 109:3e6f0e8fca0d 7 * All Rights Reserved
TickTock 109:3e6f0e8fca0d 8 *
TickTock 109:3e6f0e8fca0d 9 * www.nxp.com
TickTock 109:3e6f0e8fca0d 10 * www.onchiptech.com
TickTock 109:3e6f0e8fca0d 11 *
TickTock 109:3e6f0e8fca0d 12 * File : usbhost_ms.c
TickTock 109:3e6f0e8fca0d 13 * Programmer(s) : Ravikanth.P
TickTock 109:3e6f0e8fca0d 14 * Version :
TickTock 109:3e6f0e8fca0d 15 *
TickTock 109:3e6f0e8fca0d 16 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 17 */
TickTock 109:3e6f0e8fca0d 18
TickTock 109:3e6f0e8fca0d 19 /*
TickTock 109:3e6f0e8fca0d 20 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 21 * INCLUDE HEADER FILES
TickTock 109:3e6f0e8fca0d 22 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 23 */
TickTock 109:3e6f0e8fca0d 24
TickTock 109:3e6f0e8fca0d 25 #include "usbhost_ms.h"
TickTock 109:3e6f0e8fca0d 26
TickTock 109:3e6f0e8fca0d 27 /*
TickTock 109:3e6f0e8fca0d 28 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 29 * GLOBAL VARIABLES
TickTock 109:3e6f0e8fca0d 30 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 31 */
TickTock 109:3e6f0e8fca0d 32
TickTock 109:3e6f0e8fca0d 33 USB_INT32U MS_BlkSize;
TickTock 109:3e6f0e8fca0d 34
TickTock 109:3e6f0e8fca0d 35 /*
TickTock 109:3e6f0e8fca0d 36 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 37 * INITIALIZE MASS STORAGE INTERFACE
TickTock 109:3e6f0e8fca0d 38 *
TickTock 109:3e6f0e8fca0d 39 * Description: This function initializes the mass storage interface
TickTock 109:3e6f0e8fca0d 40 *
TickTock 109:3e6f0e8fca0d 41 * Arguments : None
TickTock 109:3e6f0e8fca0d 42 *
TickTock 109:3e6f0e8fca0d 43 * Returns : OK if Success
TickTock 109:3e6f0e8fca0d 44 * ERR_INVALID_BOOTSIG if Failed
TickTock 109:3e6f0e8fca0d 45 *
TickTock 109:3e6f0e8fca0d 46 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 47 */
TickTock 109:3e6f0e8fca0d 48
TickTock 109:3e6f0e8fca0d 49 USB_INT32S MS_Init (USB_INT32U *blkSize, USB_INT32U *numBlks, USB_INT08U *inquiryResult)
TickTock 109:3e6f0e8fca0d 50 {
TickTock 109:3e6f0e8fca0d 51 USB_INT08U retry;
TickTock 109:3e6f0e8fca0d 52 USB_INT32S rc;
TickTock 109:3e6f0e8fca0d 53
TickTock 109:3e6f0e8fca0d 54 MS_GetMaxLUN(); /* Get maximum logical unit number */
TickTock 109:3e6f0e8fca0d 55 retry = 80;
TickTock 109:3e6f0e8fca0d 56 while(retry) {
TickTock 109:3e6f0e8fca0d 57 rc = MS_TestUnitReady(); /* Test whether the unit is ready */
TickTock 109:3e6f0e8fca0d 58 if (rc == OK) {
TickTock 109:3e6f0e8fca0d 59 break;
TickTock 109:3e6f0e8fca0d 60 }
TickTock 109:3e6f0e8fca0d 61 MS_GetSenseInfo(); /* Get sense information */
TickTock 109:3e6f0e8fca0d 62 retry--;
TickTock 109:3e6f0e8fca0d 63 }
TickTock 109:3e6f0e8fca0d 64 if (rc != OK) {
TickTock 109:3e6f0e8fca0d 65 PRINT_Err(rc);
TickTock 109:3e6f0e8fca0d 66 return (rc);
TickTock 109:3e6f0e8fca0d 67 }
TickTock 109:3e6f0e8fca0d 68 rc = MS_ReadCapacity(numBlks, blkSize); /* Read capacity of the disk */
TickTock 109:3e6f0e8fca0d 69 MS_BlkSize = *blkSize; // Set global
TickTock 109:3e6f0e8fca0d 70 rc = MS_Inquire (inquiryResult);
TickTock 109:3e6f0e8fca0d 71 return (rc);
TickTock 109:3e6f0e8fca0d 72 }
TickTock 109:3e6f0e8fca0d 73 /*
TickTock 109:3e6f0e8fca0d 74 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 75 * PARSE THE CONFIGURATION
TickTock 109:3e6f0e8fca0d 76 *
TickTock 109:3e6f0e8fca0d 77 * Description: This function is used to parse the configuration
TickTock 109:3e6f0e8fca0d 78 *
TickTock 109:3e6f0e8fca0d 79 * Arguments : None
TickTock 109:3e6f0e8fca0d 80 *
TickTock 109:3e6f0e8fca0d 81 * Returns : OK if Success
TickTock 109:3e6f0e8fca0d 82 * ERR_INVALID_BOOTSIG if Failed
TickTock 109:3e6f0e8fca0d 83 *
TickTock 109:3e6f0e8fca0d 84 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 85 */
TickTock 109:3e6f0e8fca0d 86
TickTock 109:3e6f0e8fca0d 87 USB_INT32S MS_ParseConfiguration (void)
TickTock 109:3e6f0e8fca0d 88 {
TickTock 109:3e6f0e8fca0d 89 volatile USB_INT08U *desc_ptr;
TickTock 109:3e6f0e8fca0d 90 USB_INT08U ms_int_found;
TickTock 109:3e6f0e8fca0d 91
TickTock 109:3e6f0e8fca0d 92
TickTock 109:3e6f0e8fca0d 93 desc_ptr = TDBuffer;
TickTock 109:3e6f0e8fca0d 94 ms_int_found = 0;
TickTock 109:3e6f0e8fca0d 95
TickTock 109:3e6f0e8fca0d 96 if (desc_ptr[1] != USB_DESCRIPTOR_TYPE_CONFIGURATION) {
TickTock 109:3e6f0e8fca0d 97 return (ERR_BAD_CONFIGURATION);
TickTock 109:3e6f0e8fca0d 98 }
TickTock 109:3e6f0e8fca0d 99 desc_ptr += desc_ptr[0];
TickTock 109:3e6f0e8fca0d 100
TickTock 109:3e6f0e8fca0d 101 while (desc_ptr != TDBuffer + ReadLE16U(&TDBuffer[2])) {
TickTock 109:3e6f0e8fca0d 102
TickTock 109:3e6f0e8fca0d 103 switch (desc_ptr[1]) {
TickTock 109:3e6f0e8fca0d 104
TickTock 109:3e6f0e8fca0d 105 case USB_DESCRIPTOR_TYPE_INTERFACE: /* If it is an interface descriptor */
TickTock 109:3e6f0e8fca0d 106 if (desc_ptr[5] == MASS_STORAGE_CLASS && /* check if the class is mass storage */
TickTock 109:3e6f0e8fca0d 107 desc_ptr[6] == MASS_STORAGE_SUBCLASS_SCSI && /* check if the subclass is SCSI */
TickTock 109:3e6f0e8fca0d 108 desc_ptr[7] == MASS_STORAGE_PROTOCOL_BO) { /* check if the protocol is Bulk only */
TickTock 109:3e6f0e8fca0d 109 ms_int_found = 1;
TickTock 109:3e6f0e8fca0d 110 desc_ptr += desc_ptr[0]; /* Move to next descriptor start */
TickTock 109:3e6f0e8fca0d 111 }
TickTock 109:3e6f0e8fca0d 112 break;
TickTock 109:3e6f0e8fca0d 113
TickTock 109:3e6f0e8fca0d 114 case USB_DESCRIPTOR_TYPE_ENDPOINT: /* If it is an endpoint descriptor */
TickTock 109:3e6f0e8fca0d 115 if ((desc_ptr[3] & 0x03) == 0x02) { /* If it is Bulk endpoint */
TickTock 109:3e6f0e8fca0d 116 if (desc_ptr[2] & 0x80) { /* If it is In endpoint */
TickTock 109:3e6f0e8fca0d 117 EDBulkIn->Control = 1 | /* USB address */
TickTock 109:3e6f0e8fca0d 118 ((desc_ptr[2] & 0x7F) << 7) | /* Endpoint address */
TickTock 109:3e6f0e8fca0d 119 (2 << 11) | /* direction */
TickTock 109:3e6f0e8fca0d 120 (ReadLE16U(&desc_ptr[4]) << 16); /* MaxPkt Size */
TickTock 109:3e6f0e8fca0d 121 desc_ptr += desc_ptr[0]; /* Move to next descriptor start */
TickTock 109:3e6f0e8fca0d 122 } else { /* If it is Out endpoint */
TickTock 109:3e6f0e8fca0d 123 EDBulkOut->Control = 1 | /* USB address */
TickTock 109:3e6f0e8fca0d 124 ((desc_ptr[2] & 0x7F) << 7) | /* Endpoint address */
TickTock 109:3e6f0e8fca0d 125 (1 << 11) | /* direction */
TickTock 109:3e6f0e8fca0d 126 (ReadLE16U(&desc_ptr[4]) << 16); /* MaxPkt Size */
TickTock 109:3e6f0e8fca0d 127 desc_ptr += desc_ptr[0]; /* Move to next descriptor start */
TickTock 109:3e6f0e8fca0d 128 }
TickTock 109:3e6f0e8fca0d 129 } else { /* If it is not bulk end point */
TickTock 109:3e6f0e8fca0d 130 desc_ptr += desc_ptr[0]; /* Move to next descriptor start */
TickTock 109:3e6f0e8fca0d 131 }
TickTock 109:3e6f0e8fca0d 132 break;
TickTock 109:3e6f0e8fca0d 133
TickTock 109:3e6f0e8fca0d 134 default: /* If the descriptor is neither interface nor endpoint */
TickTock 109:3e6f0e8fca0d 135 desc_ptr += desc_ptr[0]; /* Move to next descriptor start */
TickTock 109:3e6f0e8fca0d 136 break;
TickTock 109:3e6f0e8fca0d 137 }
TickTock 109:3e6f0e8fca0d 138 }
TickTock 109:3e6f0e8fca0d 139 if (ms_int_found) {
TickTock 109:3e6f0e8fca0d 140 PRINT_Log("Mass Storage device connected\n");
TickTock 109:3e6f0e8fca0d 141 return (OK);
TickTock 109:3e6f0e8fca0d 142 } else {
TickTock 109:3e6f0e8fca0d 143 PRINT_Log("Not a Mass Storage device\n");
TickTock 109:3e6f0e8fca0d 144 return (ERR_NO_MS_INTERFACE);
TickTock 109:3e6f0e8fca0d 145 }
TickTock 109:3e6f0e8fca0d 146 }
TickTock 109:3e6f0e8fca0d 147
TickTock 109:3e6f0e8fca0d 148 /*
TickTock 109:3e6f0e8fca0d 149 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 150 * GET MAXIMUM LOGICAL UNIT
TickTock 109:3e6f0e8fca0d 151 *
TickTock 109:3e6f0e8fca0d 152 * Description: This function returns the maximum logical unit from the device
TickTock 109:3e6f0e8fca0d 153 *
TickTock 109:3e6f0e8fca0d 154 * Arguments : None
TickTock 109:3e6f0e8fca0d 155 *
TickTock 109:3e6f0e8fca0d 156 * Returns : OK if Success
TickTock 109:3e6f0e8fca0d 157 * ERR_INVALID_BOOTSIG if Failed
TickTock 109:3e6f0e8fca0d 158 *
TickTock 109:3e6f0e8fca0d 159 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 160 */
TickTock 109:3e6f0e8fca0d 161
TickTock 109:3e6f0e8fca0d 162 USB_INT32S MS_GetMaxLUN (void)
TickTock 109:3e6f0e8fca0d 163 {
TickTock 109:3e6f0e8fca0d 164 USB_INT32S rc;
TickTock 109:3e6f0e8fca0d 165
TickTock 109:3e6f0e8fca0d 166
TickTock 109:3e6f0e8fca0d 167 rc = Host_CtrlRecv(USB_DEVICE_TO_HOST | USB_REQUEST_TYPE_CLASS | USB_RECIPIENT_INTERFACE,
TickTock 109:3e6f0e8fca0d 168 MS_GET_MAX_LUN_REQ,
TickTock 109:3e6f0e8fca0d 169 0,
TickTock 109:3e6f0e8fca0d 170 0,
TickTock 109:3e6f0e8fca0d 171 1,
TickTock 109:3e6f0e8fca0d 172 TDBuffer);
TickTock 109:3e6f0e8fca0d 173 return (rc);
TickTock 109:3e6f0e8fca0d 174 }
TickTock 109:3e6f0e8fca0d 175
TickTock 109:3e6f0e8fca0d 176 /*
TickTock 109:3e6f0e8fca0d 177 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 178 * GET SENSE INFORMATION
TickTock 109:3e6f0e8fca0d 179 *
TickTock 109:3e6f0e8fca0d 180 * Description: This function is used to get sense information from the device
TickTock 109:3e6f0e8fca0d 181 *
TickTock 109:3e6f0e8fca0d 182 * Arguments : None
TickTock 109:3e6f0e8fca0d 183 *
TickTock 109:3e6f0e8fca0d 184 * Returns : OK if Success
TickTock 109:3e6f0e8fca0d 185 * ERROR if Failed
TickTock 109:3e6f0e8fca0d 186 *
TickTock 109:3e6f0e8fca0d 187 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 188 */
TickTock 109:3e6f0e8fca0d 189
TickTock 109:3e6f0e8fca0d 190 USB_INT32S MS_GetSenseInfo (void)
TickTock 109:3e6f0e8fca0d 191 {
TickTock 109:3e6f0e8fca0d 192 USB_INT32S rc;
TickTock 109:3e6f0e8fca0d 193
TickTock 109:3e6f0e8fca0d 194
TickTock 109:3e6f0e8fca0d 195 Fill_MSCommand(0, 0, 0, MS_DATA_DIR_IN, SCSI_CMD_REQUEST_SENSE, 6);
TickTock 109:3e6f0e8fca0d 196 rc = Host_ProcessTD(EDBulkOut, TD_OUT, TDBuffer, CBW_SIZE);
TickTock 109:3e6f0e8fca0d 197 if (rc == OK) {
TickTock 109:3e6f0e8fca0d 198 rc = Host_ProcessTD(EDBulkIn, TD_IN, TDBuffer, 18);
TickTock 109:3e6f0e8fca0d 199 if (rc == OK) {
TickTock 109:3e6f0e8fca0d 200 rc = Host_ProcessTD(EDBulkIn, TD_IN, TDBuffer, CSW_SIZE);
TickTock 109:3e6f0e8fca0d 201 if (rc == OK) {
TickTock 109:3e6f0e8fca0d 202 if (TDBuffer[12] != 0) {
TickTock 109:3e6f0e8fca0d 203 rc = ERR_MS_CMD_FAILED;
TickTock 109:3e6f0e8fca0d 204 }
TickTock 109:3e6f0e8fca0d 205 }
TickTock 109:3e6f0e8fca0d 206 }
TickTock 109:3e6f0e8fca0d 207 }
TickTock 109:3e6f0e8fca0d 208 return (rc);
TickTock 109:3e6f0e8fca0d 209 }
TickTock 109:3e6f0e8fca0d 210
TickTock 109:3e6f0e8fca0d 211 /*
TickTock 109:3e6f0e8fca0d 212 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 213 * TEST UNIT READY
TickTock 109:3e6f0e8fca0d 214 *
TickTock 109:3e6f0e8fca0d 215 * Description: This function is used to test whether the unit is ready or not
TickTock 109:3e6f0e8fca0d 216 *
TickTock 109:3e6f0e8fca0d 217 * Arguments : None
TickTock 109:3e6f0e8fca0d 218 *
TickTock 109:3e6f0e8fca0d 219 * Returns : OK if Success
TickTock 109:3e6f0e8fca0d 220 * ERROR if Failed
TickTock 109:3e6f0e8fca0d 221 *
TickTock 109:3e6f0e8fca0d 222 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 223 */
TickTock 109:3e6f0e8fca0d 224
TickTock 109:3e6f0e8fca0d 225 USB_INT32S MS_TestUnitReady (void)
TickTock 109:3e6f0e8fca0d 226 {
TickTock 109:3e6f0e8fca0d 227 USB_INT32S rc;
TickTock 109:3e6f0e8fca0d 228
TickTock 109:3e6f0e8fca0d 229
TickTock 109:3e6f0e8fca0d 230 Fill_MSCommand(0, 0, 0, MS_DATA_DIR_NONE, SCSI_CMD_TEST_UNIT_READY, 6);
TickTock 109:3e6f0e8fca0d 231 rc = Host_ProcessTD(EDBulkOut, TD_OUT, TDBuffer, CBW_SIZE);
TickTock 109:3e6f0e8fca0d 232 if (rc == OK) {
TickTock 109:3e6f0e8fca0d 233 rc = Host_ProcessTD(EDBulkIn, TD_IN, TDBuffer, CSW_SIZE);
TickTock 109:3e6f0e8fca0d 234 if (rc == OK) {
TickTock 109:3e6f0e8fca0d 235 if (TDBuffer[12] != 0) {
TickTock 109:3e6f0e8fca0d 236 rc = ERR_MS_CMD_FAILED;
TickTock 109:3e6f0e8fca0d 237 }
TickTock 109:3e6f0e8fca0d 238 }
TickTock 109:3e6f0e8fca0d 239 }
TickTock 109:3e6f0e8fca0d 240 return (rc);
TickTock 109:3e6f0e8fca0d 241 }
TickTock 109:3e6f0e8fca0d 242
TickTock 109:3e6f0e8fca0d 243 /*
TickTock 109:3e6f0e8fca0d 244 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 245 * READ CAPACITY
TickTock 109:3e6f0e8fca0d 246 *
TickTock 109:3e6f0e8fca0d 247 * Description: This function is used to read the capacity of the mass storage device
TickTock 109:3e6f0e8fca0d 248 *
TickTock 109:3e6f0e8fca0d 249 * Arguments : None
TickTock 109:3e6f0e8fca0d 250 *
TickTock 109:3e6f0e8fca0d 251 * Returns : OK if Success
TickTock 109:3e6f0e8fca0d 252 * ERROR if Failed
TickTock 109:3e6f0e8fca0d 253 *
TickTock 109:3e6f0e8fca0d 254 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 255 */
TickTock 109:3e6f0e8fca0d 256
TickTock 109:3e6f0e8fca0d 257 USB_INT32S MS_ReadCapacity (USB_INT32U *numBlks, USB_INT32U *blkSize)
TickTock 109:3e6f0e8fca0d 258 {
TickTock 109:3e6f0e8fca0d 259 USB_INT32S rc;
TickTock 109:3e6f0e8fca0d 260
TickTock 109:3e6f0e8fca0d 261
TickTock 109:3e6f0e8fca0d 262 Fill_MSCommand(0, 0, 0, MS_DATA_DIR_IN, SCSI_CMD_READ_CAPACITY, 10);
TickTock 109:3e6f0e8fca0d 263 rc = Host_ProcessTD(EDBulkOut, TD_OUT, TDBuffer, CBW_SIZE);
TickTock 109:3e6f0e8fca0d 264 if (rc == OK) {
TickTock 109:3e6f0e8fca0d 265 rc = Host_ProcessTD(EDBulkIn, TD_IN, TDBuffer, 8);
TickTock 109:3e6f0e8fca0d 266 if (rc == OK) {
TickTock 109:3e6f0e8fca0d 267 if (numBlks)
TickTock 109:3e6f0e8fca0d 268 *numBlks = ReadBE32U(&TDBuffer[0]);
TickTock 109:3e6f0e8fca0d 269 if (blkSize)
TickTock 109:3e6f0e8fca0d 270 *blkSize = ReadBE32U(&TDBuffer[4]);
TickTock 109:3e6f0e8fca0d 271 rc = Host_ProcessTD(EDBulkIn, TD_IN, TDBuffer, CSW_SIZE);
TickTock 109:3e6f0e8fca0d 272 if (rc == OK) {
TickTock 109:3e6f0e8fca0d 273 if (TDBuffer[12] != 0) {
TickTock 109:3e6f0e8fca0d 274 rc = ERR_MS_CMD_FAILED;
TickTock 109:3e6f0e8fca0d 275 }
TickTock 109:3e6f0e8fca0d 276 }
TickTock 109:3e6f0e8fca0d 277 }
TickTock 109:3e6f0e8fca0d 278 }
TickTock 109:3e6f0e8fca0d 279 return (rc);
TickTock 109:3e6f0e8fca0d 280 }
TickTock 109:3e6f0e8fca0d 281
TickTock 109:3e6f0e8fca0d 282
TickTock 109:3e6f0e8fca0d 283
TickTock 109:3e6f0e8fca0d 284 USB_INT32S MS_Inquire (USB_INT08U *response)
TickTock 109:3e6f0e8fca0d 285 {
TickTock 109:3e6f0e8fca0d 286 USB_INT32S rc;
TickTock 109:3e6f0e8fca0d 287 USB_INT32U i;
TickTock 109:3e6f0e8fca0d 288
TickTock 109:3e6f0e8fca0d 289 Fill_MSCommand(0, 0, 0, MS_DATA_DIR_IN, SCSI_CMD_INQUIRY, 6);
TickTock 109:3e6f0e8fca0d 290 rc = Host_ProcessTD(EDBulkOut, TD_OUT, TDBuffer, CBW_SIZE);
TickTock 109:3e6f0e8fca0d 291 if (rc == OK) {
TickTock 109:3e6f0e8fca0d 292 rc = Host_ProcessTD(EDBulkIn, TD_IN, TDBuffer, INQUIRY_LENGTH);
TickTock 109:3e6f0e8fca0d 293 if (rc == OK) {
TickTock 109:3e6f0e8fca0d 294 if (response) {
TickTock 109:3e6f0e8fca0d 295 for ( i = 0; i < INQUIRY_LENGTH; i++ )
TickTock 109:3e6f0e8fca0d 296 *response++ = *TDBuffer++;
TickTock 109:3e6f0e8fca0d 297 #if 0
TickTock 109:3e6f0e8fca0d 298 MemCpy (response, TDBuffer, INQUIRY_LENGTH);
TickTock 109:3e6f0e8fca0d 299 StrNullTrailingSpace (response->vendorID, SCSI_INQUIRY_VENDORCHARS);
TickTock 109:3e6f0e8fca0d 300 StrNullTrailingSpace (response->productID, SCSI_INQUIRY_PRODUCTCHARS);
TickTock 109:3e6f0e8fca0d 301 StrNullTrailingSpace (response->productRev, SCSI_INQUIRY_REVCHARS);
TickTock 109:3e6f0e8fca0d 302 #endif
TickTock 109:3e6f0e8fca0d 303 }
TickTock 109:3e6f0e8fca0d 304 rc = Host_ProcessTD(EDBulkIn, TD_IN, TDBuffer, CSW_SIZE);
TickTock 109:3e6f0e8fca0d 305 if (rc == OK) {
TickTock 109:3e6f0e8fca0d 306 if (TDBuffer[12] != 0) { // bCSWStatus byte
TickTock 109:3e6f0e8fca0d 307 rc = ERR_MS_CMD_FAILED;
TickTock 109:3e6f0e8fca0d 308 }
TickTock 109:3e6f0e8fca0d 309 }
TickTock 109:3e6f0e8fca0d 310 }
TickTock 109:3e6f0e8fca0d 311 }
TickTock 109:3e6f0e8fca0d 312 return (rc);
TickTock 109:3e6f0e8fca0d 313 }
TickTock 109:3e6f0e8fca0d 314
TickTock 109:3e6f0e8fca0d 315 /*
TickTock 109:3e6f0e8fca0d 316 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 317 * RECEIVE THE BULK DATA
TickTock 109:3e6f0e8fca0d 318 *
TickTock 109:3e6f0e8fca0d 319 * Description: This function is used to receive the bulk data
TickTock 109:3e6f0e8fca0d 320 *
TickTock 109:3e6f0e8fca0d 321 * Arguments : None
TickTock 109:3e6f0e8fca0d 322 *
TickTock 109:3e6f0e8fca0d 323 * Returns : OK if Success
TickTock 109:3e6f0e8fca0d 324 * ERR_INVALID_BOOTSIG if Failed
TickTock 109:3e6f0e8fca0d 325 *
TickTock 109:3e6f0e8fca0d 326 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 327 */
TickTock 109:3e6f0e8fca0d 328
TickTock 109:3e6f0e8fca0d 329 USB_INT32S MS_BulkRecv ( USB_INT32U block_number,
TickTock 109:3e6f0e8fca0d 330 USB_INT16U num_blocks,
TickTock 109:3e6f0e8fca0d 331 volatile USB_INT08U *user_buffer)
TickTock 109:3e6f0e8fca0d 332 {
TickTock 109:3e6f0e8fca0d 333 USB_INT32S rc;
TickTock 109:3e6f0e8fca0d 334 int i;
TickTock 109:3e6f0e8fca0d 335 volatile USB_INT08U *c = user_buffer;
TickTock 109:3e6f0e8fca0d 336 for (i=0;i<MS_BlkSize*num_blocks;i++)
TickTock 109:3e6f0e8fca0d 337 *c++ = 0;
TickTock 109:3e6f0e8fca0d 338
TickTock 109:3e6f0e8fca0d 339
TickTock 109:3e6f0e8fca0d 340 Fill_MSCommand(block_number, MS_BlkSize, num_blocks, MS_DATA_DIR_IN, SCSI_CMD_READ_10, 10);
TickTock 109:3e6f0e8fca0d 341
TickTock 109:3e6f0e8fca0d 342 rc = Host_ProcessTD(EDBulkOut, TD_OUT, TDBuffer, CBW_SIZE);
TickTock 109:3e6f0e8fca0d 343 if (rc == OK) {
TickTock 109:3e6f0e8fca0d 344 rc = Host_ProcessTD(EDBulkIn, TD_IN, user_buffer, MS_BlkSize * num_blocks);
TickTock 109:3e6f0e8fca0d 345 if (rc == OK) {
TickTock 109:3e6f0e8fca0d 346 rc = Host_ProcessTD(EDBulkIn, TD_IN, TDBuffer, CSW_SIZE);
TickTock 109:3e6f0e8fca0d 347 if (rc == OK) {
TickTock 109:3e6f0e8fca0d 348 if (TDBuffer[12] != 0) {
TickTock 109:3e6f0e8fca0d 349 rc = ERR_MS_CMD_FAILED;
TickTock 109:3e6f0e8fca0d 350 }
TickTock 109:3e6f0e8fca0d 351 }
TickTock 109:3e6f0e8fca0d 352 }
TickTock 109:3e6f0e8fca0d 353 }
TickTock 109:3e6f0e8fca0d 354 return (rc);
TickTock 109:3e6f0e8fca0d 355 }
TickTock 109:3e6f0e8fca0d 356
TickTock 109:3e6f0e8fca0d 357 /*
TickTock 109:3e6f0e8fca0d 358 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 359 * SEND BULK DATA
TickTock 109:3e6f0e8fca0d 360 *
TickTock 109:3e6f0e8fca0d 361 * Description: This function is used to send the bulk data
TickTock 109:3e6f0e8fca0d 362 *
TickTock 109:3e6f0e8fca0d 363 * Arguments : None
TickTock 109:3e6f0e8fca0d 364 *
TickTock 109:3e6f0e8fca0d 365 * Returns : OK if Success
TickTock 109:3e6f0e8fca0d 366 * ERR_INVALID_BOOTSIG if Failed
TickTock 109:3e6f0e8fca0d 367 *
TickTock 109:3e6f0e8fca0d 368 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 369 */
TickTock 109:3e6f0e8fca0d 370
TickTock 109:3e6f0e8fca0d 371 USB_INT32S MS_BulkSend ( USB_INT32U block_number,
TickTock 109:3e6f0e8fca0d 372 USB_INT16U num_blocks,
TickTock 109:3e6f0e8fca0d 373 volatile USB_INT08U *user_buffer)
TickTock 109:3e6f0e8fca0d 374 {
TickTock 109:3e6f0e8fca0d 375 USB_INT32S rc;
TickTock 109:3e6f0e8fca0d 376
TickTock 109:3e6f0e8fca0d 377
TickTock 109:3e6f0e8fca0d 378 Fill_MSCommand(block_number, MS_BlkSize, num_blocks, MS_DATA_DIR_OUT, SCSI_CMD_WRITE_10, 10);
TickTock 109:3e6f0e8fca0d 379
TickTock 109:3e6f0e8fca0d 380 rc = Host_ProcessTD(EDBulkOut, TD_OUT, TDBuffer, CBW_SIZE);
TickTock 109:3e6f0e8fca0d 381 if (rc == OK) {
TickTock 109:3e6f0e8fca0d 382 rc = Host_ProcessTD(EDBulkOut, TD_OUT, user_buffer, MS_BlkSize * num_blocks);
TickTock 109:3e6f0e8fca0d 383 if (rc == OK) {
TickTock 109:3e6f0e8fca0d 384 rc = Host_ProcessTD(EDBulkIn, TD_IN, TDBuffer, CSW_SIZE);
TickTock 109:3e6f0e8fca0d 385 if (rc == OK) {
TickTock 109:3e6f0e8fca0d 386 if (TDBuffer[12] != 0) {
TickTock 109:3e6f0e8fca0d 387 rc = ERR_MS_CMD_FAILED;
TickTock 109:3e6f0e8fca0d 388 }
TickTock 109:3e6f0e8fca0d 389 }
TickTock 109:3e6f0e8fca0d 390 }
TickTock 109:3e6f0e8fca0d 391 }
TickTock 109:3e6f0e8fca0d 392 return (rc);
TickTock 109:3e6f0e8fca0d 393 }
TickTock 109:3e6f0e8fca0d 394
TickTock 109:3e6f0e8fca0d 395 /*
TickTock 109:3e6f0e8fca0d 396 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 397 * FILL MASS STORAGE COMMAND
TickTock 109:3e6f0e8fca0d 398 *
TickTock 109:3e6f0e8fca0d 399 * Description: This function is used to fill the mass storage command
TickTock 109:3e6f0e8fca0d 400 *
TickTock 109:3e6f0e8fca0d 401 * Arguments : None
TickTock 109:3e6f0e8fca0d 402 *
TickTock 109:3e6f0e8fca0d 403 * Returns : OK if Success
TickTock 109:3e6f0e8fca0d 404 * ERR_INVALID_BOOTSIG if Failed
TickTock 109:3e6f0e8fca0d 405 *
TickTock 109:3e6f0e8fca0d 406 **************************************************************************************************************
TickTock 109:3e6f0e8fca0d 407 */
TickTock 109:3e6f0e8fca0d 408
TickTock 109:3e6f0e8fca0d 409 void Fill_MSCommand (USB_INT32U block_number,
TickTock 109:3e6f0e8fca0d 410 USB_INT32U block_size,
TickTock 109:3e6f0e8fca0d 411 USB_INT16U num_blocks,
TickTock 109:3e6f0e8fca0d 412 MS_DATA_DIR direction,
TickTock 109:3e6f0e8fca0d 413 USB_INT08U scsi_cmd,
TickTock 109:3e6f0e8fca0d 414 USB_INT08U scsi_cmd_len)
TickTock 109:3e6f0e8fca0d 415 {
TickTock 109:3e6f0e8fca0d 416 USB_INT32U data_len;
TickTock 109:3e6f0e8fca0d 417 static USB_INT32U tag_cnt = 0;
TickTock 109:3e6f0e8fca0d 418 USB_INT32U cnt;
TickTock 109:3e6f0e8fca0d 419
TickTock 109:3e6f0e8fca0d 420
TickTock 109:3e6f0e8fca0d 421 for (cnt = 0; cnt < CBW_SIZE; cnt++) {
TickTock 109:3e6f0e8fca0d 422 TDBuffer[cnt] = 0;
TickTock 109:3e6f0e8fca0d 423 }
TickTock 109:3e6f0e8fca0d 424 switch(scsi_cmd) {
TickTock 109:3e6f0e8fca0d 425
TickTock 109:3e6f0e8fca0d 426 case SCSI_CMD_TEST_UNIT_READY:
TickTock 109:3e6f0e8fca0d 427 data_len = 0;
TickTock 109:3e6f0e8fca0d 428 break;
TickTock 109:3e6f0e8fca0d 429 case SCSI_CMD_READ_CAPACITY:
TickTock 109:3e6f0e8fca0d 430 data_len = 8;
TickTock 109:3e6f0e8fca0d 431 break;
TickTock 109:3e6f0e8fca0d 432 case SCSI_CMD_REQUEST_SENSE:
TickTock 109:3e6f0e8fca0d 433 data_len = 18;
TickTock 109:3e6f0e8fca0d 434 break;
TickTock 109:3e6f0e8fca0d 435 case SCSI_CMD_INQUIRY:
TickTock 109:3e6f0e8fca0d 436 data_len = 36;
TickTock 109:3e6f0e8fca0d 437 break;
TickTock 109:3e6f0e8fca0d 438 default:
TickTock 109:3e6f0e8fca0d 439 data_len = block_size * num_blocks;
TickTock 109:3e6f0e8fca0d 440 break;
TickTock 109:3e6f0e8fca0d 441 }
TickTock 109:3e6f0e8fca0d 442 WriteLE32U(TDBuffer, CBW_SIGNATURE);
TickTock 109:3e6f0e8fca0d 443 WriteLE32U(&TDBuffer[4], tag_cnt);
TickTock 109:3e6f0e8fca0d 444 WriteLE32U(&TDBuffer[8], data_len);
TickTock 109:3e6f0e8fca0d 445 TDBuffer[12] = (direction == MS_DATA_DIR_NONE) ? 0 : direction;
TickTock 109:3e6f0e8fca0d 446 TDBuffer[14] = scsi_cmd_len; /* Length of the CBW */
TickTock 109:3e6f0e8fca0d 447 TDBuffer[15] = scsi_cmd;
TickTock 109:3e6f0e8fca0d 448 if ((scsi_cmd == SCSI_CMD_REQUEST_SENSE)
TickTock 109:3e6f0e8fca0d 449 || (scsi_cmd == SCSI_CMD_INQUIRY)) {
TickTock 109:3e6f0e8fca0d 450 TDBuffer[19] = (USB_INT08U)data_len;
TickTock 109:3e6f0e8fca0d 451 } else {
TickTock 109:3e6f0e8fca0d 452 WriteBE32U(&TDBuffer[17], block_number);
TickTock 109:3e6f0e8fca0d 453 }
TickTock 109:3e6f0e8fca0d 454 WriteBE16U(&TDBuffer[22], num_blocks);
TickTock 109:3e6f0e8fca0d 455 }