How to configure SPI_FILE_SYSTEM to work with serial loader

[Ray]

Hi Mark

On a main application, the SPI_FILE_SYSTEM  based on SPI_FLASH_W25Q128 devices (16MB)  seems to work perfectly as a USB MSD. 
(I needed to commented out   // #define ACTIVE_FILE_SYSTEM    which appeared to mess with my FAT32 format)
Reading and writing files and dragging folders to the DISK seems to be fully operational. 

I've had the serial loader with the SDCARD working, but flash chips are a whole lot better solution for me.
It's time for me to tackle the problem with the serial loader.  First, just treating it as a USB MSD doesn't seem to work.  with the  #defines set like this, it seems to lockup. 

loader.h
#define UTASKER_APP_START     (36 * 1024)
#define UTASKER_APP_END           (unsigned char *)(UTASKER_APP_START + (476 * 1024))
#define _UTASKER_APP_START_   (UTASKER_APP_START + (ROOT_FILE_ENTRIES * 32))

config.h of serial loader
    #define USB_INTERFACE                                                // enable USB driver interface
#define USB_MSD_DEVICE_LOADER                                 // USB-MSD device mode (the board appears as a hard-drive to the host)
   
#define USB_DEVICE_SUPPORT             
#define USB_MSD_TIMEOUT       
#define SPI_FLASH_FAT                                                // SPI flash
#define SIMPLE_FLASH                                             // don't perform block management and wear-leveling
#define FLASH_FAT_MANAGEMENT_ADDRESS     (SIZE_OF_FLASH)
#define DELETE_SDCARD_FILE_AFTER_UPDATE   

#define UTFAT_WRITE
#define UTFAT_LFN_READ                                               // enable long file name read support
#define STR_EQUIV_ON                                                 // ensure that this routine is available
#define UTFAT_LFN_WRITE
#define UTFAT_LFN_WRITE_PATCH
#define RANDOM_NUMBER_GENERATOR
#define UTFAT_RETURN_FILE_CREATION_TIME   

Nothing works, it locks up, but  creates a USB_MSD

UPLOAD_DISK(F:)  1.31 MB free of 1.32MB 

This is incorrect because the flash chip is fully formatted with a folder f:\web and it's lone file when I run the application code.

I think the problem is it's not correctly configured for what it is. 

I have it configured with #define USB_MSD_DEVICE_LOADER
however I don't think this is the proper way for it to be implemented for my use-case.

For the initial programming of a new board, the serial loader should fail with this:  #define _DISPLAY_SD_CARD_NOT_PRESENT() fnDebugMsg("SD-Card not present\r\n")
Jump to the main application, and then the main application has a initialization with formats the new device...and all is well.

I'm confused as to how exactly I configure SPI_FLASH as a MSD for the serial loader?  Is it an "SD Card" or USB Device? 
It seems to to walk the line and be a little bit of both?
I noticed I can't just use USB_MSD and SDCARD_SUPPORT

FYI - when I have a properly formatted W25QXXX.ini  the UART3.txt indicates
> SD-Card presentAndFormatted
No Application

I'd like it to act like a SDCARD and the USB doesn't need to do anything until it jumps to the main application.
Debug is fine with just the UART


Oh, some other details are the linker edits, although I feel I have them correctly setup.

and my K_512_128_BM.ld uses:
MEMORY
{
    FLASH (rx) : ORIGIN = 0x00009080, LENGTH = 0x00080000-0x9080         /* 512k Flash - boot loader */
    SRAM (wx)  : ORIGIN = 0x1fff01f0, LENGTH = 0x00020000-0x1f0          /* 128k RAM with vector size 0x1f0 (488 bytes - maximum for all processors) */
}

SECTIONS
{
  __SRAM_segment_start__   = 0x1fff01f0;
  __SRAM_segment_end__     = 0x2000ffff;
  __Vector_segment_start__ = 0x00009080;                                 /* application start address */
  __Vector_segment_end__   = 0x0000908f;
  __FLASH_segment_start__  = 0x00009090;
  __FLASH_segment_end__    = 0x0007ffff;
Thanks
Ray

[Ray]

Let me add the simulator UART debug output:
 uTasker Serial Loader V1.5

===========================

[0x00009080/0x0007ffff]

me = mass erase

bc = blank check

dc = delete code

ld = start load

go = start application

> SD-Card presentAndFormatted       *** added AndFormatted to verify what I was seeing on simulator *  this is a formatted W25QXXX.ini with no code on it

SD JumpToApp(disk_loader-328)        *** I added this just before fnJumpToApplication(1);                              // {3} unconditional jump to application code

No Application (Serial_loader-4413)

Thanks
Ray

[mark]

Hi Ray

I don't see the problem by just looking at the configuration.

If I understand correctly you have an application that uses an external SPI memory as FAT media and a host works with it via USB (USB-MSD). Can your application also access the FAT and can it format it? If it can you can use the W25QXXX.ini from the simulation of the application for the serial loader simulation (by copying it to the serial loader's simulation folder). This may help debug the serial loader (when it has a known formatted FAT in the SPI Flash) to see why this is maybe not recognised as the application does. You could check that both application and serial loader are accessing the content at the same address (for example) when both mount the FAT.

Regards

Mark

[Ray]

This one really has be stumped. 
Yes, the main application when installed by itself, will enumerate the 16Mb SPI_FLASH_W25Q128.
That is the drive with a root directory for an HTTP simple interface so the web folder is on the spi flash chip and works perfectly as a standalone.

The main application when using a serial loader installs at 0x9080  The serial loader hex file confirms everything is in the correct location. 
It feels like the Serial loader is failing somewhere when accessing the spi flash device.   The serial loader enumerates a USB MSD in windows however it is only an empty 1.32 Mb  I'm hoping this is  a clue because I don't believe the chip actually is being accessed.  I use that old windows SDK program usbview.exe to read the setup info. 

The serial loader enumerates MSD but then just hangs, not jumping to the app.   
When I install only the serial loader it continually reboots and enumerates that same false value, seems like a wtd reboot.

also, in kinetis_FLASH.h when EXT_FLASH_FILE_SYSTEM  is defined,  the switch statement has a case  _STORAGE_PARALLEL_FLASH and is calling undefined functions fnWriteParallelFlash(), and fnGetExtFlashAdd().  (causes compile error)

Maybe that is a clue? I just comment out those functions since its about parallel flash not SPI flash

[Ray]

Hi Mark,
I have a tiny bit of improvement, or maybe better clues.
I downloaded the latest  remotes/origin/V2.0.0  latest commit 8/24/2023
Recall I am using the KinetisK60, parameters and swap blocks are last 4k of the 512k, no internal filesystem, the SPI flash MSD appears to work completely on the application so no hardware problem.
 
I've detailed the exact changes I made from the original to get to a point of hardware USB enumeration, incorrect enumeration, and the debug UART 3 spits out:

Debug output when powering the board and reading debug uart 3:
_DISPLAY_SD_CARD_NOT_PRESENT()   1 second delay  _DISPLAY_SD_CARD_NOT_PRESENT()    1 second delay _DISPLAY_SD_CARD_NOT_PRESENT() fnDebugMsg("No Application!!\r\n");

Clearly the hardware USB USB_MSD_DEVICE_LOADER  components are being pulled in correctly to enumerate the USB MSD, but the SPI_FLASH is not being setup correct, so it is failing this part.

config.h changes
comment line 108          #define TEENSY_3_1
uncomment line 127      #define TWR_K60N512         //  MK60DN512VLQ10
Uncomment line 1258    #define SPI_FILE_SYSTEM     // we have an external file system via SPI interface
comment line  1259       #define FLASH_FILE_SYSTEM   // we have an internal file system in FLASH

***  question regarding line 1270   #define ACTIVE_FILE_SYSTEM  This line must be commented out in my application or my FAT32 gets corrupted continuously.  Is this a special case directive?   
When my application has this defined my flash ships FAT32 is continuously corrupted

***  possible issue   **
Between 1275 and 1364  there are different configurations defines for the spi flash, however NONE are set
ADDing 2 lines after this block ***#if (defined FLASH_FILE_SYSTEM && defined SPI_FILE_SYSTEM)***  that runs from   1275 to 1364
1365  #define SPI_FLASH_W25Q                                                  // use Winbond W25Q SPI flash rather than ATMEL
1355 #define FILE_GRANULARITY (4 * SPI_FLASH_BLOCK_LENGTH)                    // defined in app_hw_kinetis.h

uncomment 1715        #define SPI_FLASH_FAT   
comment 1775            #define UTFAT16  // not needed

since I am loading from onboard IC's  I should be able to comment this out so the debugger will send debug messages?
#define UTFAT_DISABLE_DEBUG_OUT   // disable general mass-storage output so that the SREC loader is not disturbed

Loader.h  ** not much here to change  starting location is 0x9080 in the linker as I have shown in previous comments
change line 203 from 23 to 36    #define UTASKER_APP_START     (36 * 1024)   
change line 217  from 64 to 476  #define UTASKER_APP_END   (unsigned char *)(UTASKER_APP_START + (476 * 1024)) // use entire chip



app_hw_kinetis.h
Clocking Changes for my PCB:
Change line 375 from      #define EXTERNAL_CLOCK       50000000    to   #define CRYSTAL_FREQUENCY           24000000
Change line 376 to  CRYSTAL_FREQUENCY
Change  378  to 12
delete a space at 480 and insert a new line at 376  #define OSC_LOW_GAIN_MODE     
change line 804 to be PACKAGE_LQFP
Insert into blank line at 676    #define MASK_5N22D    // RJS  9/21/2022

GPIO changes:
edit lines 1809 - 1813 to PORTE_BIT26
edit lines 1821-1825 to PORTE_BIT25
edit lines 1834 watchdog init to use port E
edit 1873 and 1874  to define them to zero #define INIT_WATCHDOG_DISABLE() 0    WATCHDOG_DISABLE() 0 
Edit line 1884 to use port E

edit line 1890 to define to 1 always forcing serial loader #define FORCE_BOOT()         1         Always enter serial loader to check
edit line 1900 to define to 0 always leave loader mode     #define RETAIN_LOADER_MODE() 0   Never, always proceed


Copy lines 4808  to 4839  outside of the preprocessor define area
begin with line 4841 
#else
#define CS0_LINE                        SPI_PUSHR_PCS0           // CS0 line used when SPI FLASH is enabled
#define CS1_LINE                        SPI_PUSHR_PCS1           // CS1 line used when extended SPI FLASH is enabled
#define CS2_LINE                        SPI_PUSHR_PCS2           // CS2 line used when extended SPI FLASH is enabled
#if defined SPI_FLASH_DEVICE_COUNT && (SPI_FLASH_DEVICE_COUNT >= 4)
#define CS3_LINE                    SPI_PUSHR_PCS3           // CS3 line used when extended SPI FLASH is enabled
#endif

#define SPI_CS0_PORT                    ~(SPI0_PUSHR)            // for simulator
#define SPI_CS1_PORT                    ~(SPI0_PUSHR)            // for simulator
#define SPI_CS2_PORT                    ~(SPI0_PUSHR)            // for simulator
#define SPI_CS3_PORT                    ~(SPI0_PUSHR)            // for simulator
#define SPI_TX_BYTE                     SPI0_PUSHR               // for simulator
#define SPI_RX_BYTE                     SPI0_POPR                // for simulator
#define POWER_UP_SPI_FLASH_INTERFACE()  POWER_UP_ATOMIC(6, SPI0)
#define CONFIGURE_SPI_FLASH_INTERFACE() _CONFIG_PERIPHERAL(D, 0, (PD_0_SPI0_PCS0 | PORT_SRE_FAST | PORT_DSE_HIGH));\
                                                _CONFIG_PERIPHERAL(D, 1, (PD_1_SPI0_SCK | PORT_SRE_FAST | PORT_DSE_HIGH));\
                                                _CONFIG_PERIPHERAL(D, 2, (PD_2_SPI0_SOUT | PORT_SRE_FAST | PORT_DSE_HIGH));\
                                                _CONFIG_PERIPHERAL(D, 3, (PD_3_SPI0_SIN));\
                                                SPI0_MCR = (SPI_MCR_MSTR | SPI_MCR_DCONF_SPI | SPI_MCR_CLR_RXF | SPI_MCR_CLR_TXF | SPI_MCR_PCSIS_CS0 | SPI_MCR_PCSIS_CS1 | SPI_MCR_PCSIS_CS2 | SPI_MCR_PCSIS_CS3 | SPI_MCR_PCSIS_CS4 | SPI_MCR_PCSIS_CS5);\
                                                SPI0_CTAR0 = (SPI_CTAR_DBR | SPI_CTAR_FMSZ_8 | SPI_CTAR_PDT_7 | SPI_CTAR_BR_2 | SPI_CTAR_CPHA | SPI_CTAR_CPOL); // for 50MHz bus, 25MHz speed and 140ns min de-select time

#define POWER_DOWN_SPI_FLASH_INTERFACE() POWER_DOWN(6, SIM_SCGC6_SPI0) // power down SPI interface if no SPI Flash detected

#define FLUSH_SPI_FIFO_AND_FLAGS()      SPI0_MCR |= SPI_MCR_CLR_RXF; SPI0_SR = (SPI_SR_EOQF | SPI_SR_TFUF | SPI_SR_TFFF | SPI_SR_RFOF | SPI_SR_RFDF);

#define WRITE_SPI_CMD0(byte)            SPI0_PUSHR = (byte | SPI_PUSHR_CONT | ulChipSelectLine | SPI_PUSHR_CTAS_CTAR0) // write a single byte to the output FIFO - assert CS line
#define WRITE_SPI_CMD0_LAST(byte)       SPI0_PUSHR = (byte | SPI_PUSHR_EOQ  | ulChipSelectLine | SPI_PUSHR_CTAS_CTAR0) // write final byte to output FIFO - this will negate the CS line when complete
#define READ_SPI_FLASH_DATA()           (unsigned char)SPI0_POPR
#define WAIT_SPI_RECEPTION_END()        while ((SPI0_SR & SPI_SR_RFDF) == 0) {}
#define CLEAR_RECEPTION_FLAG()          SPI0_SR |= SPI_SR_RFDF
#define SET_SPI_FLASH_MODE()                                     // this can be used to change SPI settings on-the-fly when the SPI is shared with SPI Flash and other devices
#define REMOVE_SPI_FLASH_MODE()                                  // this can be used to change SPI settings on-the-fly when the SPI is shared with SPI Flash and other devices

line 4874 is the new
#endif
 
 
 
With these changes  I get 2 failures in KinetisSim.c (uFILE_START)  and WinSim.c (FILE_SYSTEM_SIZE)  NOT FOUND
 
I add  into app_hw_kinetis.h  4875 and 4876
#define FILE_SYSTEM_SIZE   (128*1024)
#define uFILE_START   (512 * 1024)

[mark]

Hi Ray

fnWriteParallelFlash() is only available in the Coldfire project so EXT_FLASH_FILE_SYSTEM should not be defined in the Kinetis project.

Regards

Mark

[Ray]

Hi Mark,
Actually I'm not sure where that comment about EXT_FLASH_FILE_SYSTEM came from.  Yes, that definitely has no place in the loading process.

I've taken a step back and tried to think logically where the problem might be coming from.
Except for disk_loader.c, serial_loader.c usb_application.c and usb_device_loader.c every other driver file for the serial loader is in the main application.

Except for config.h, loader.h and app_hw_kinetis.h
Clearly, config.h and loader.h are project specific, however, app_hw_kenitis.h has no reason to be different from the main application since it is essentially the glue between the drivers and the hardware layout.  So I took the main application app_hw_kinetis.h, added about 4-5 preprocessor directives and a bunch of fnDebugMsg()   and RESET_PEREPHIALS()

No, same problem.
I did find more issues  usb_device_loader.c does not properly call FAT32.   line 351
#if !defined FAT_EMULATION
    #if !defined iMX_MAX_APPLICATION_SIZE || iMX_MAX_APPLICATION_SIZE <= (512 * 1024)
        #define UTFAT12                                                  *****causes all sorts of problems
    #endif

    #if defined UTFAT12
        #define BOOT_SECTOR_LOCATION           1
        #define BACKUP_ROOT_SECTOR             1
        #define BYTES_PER_SECTOR               512
        #define RESERVED_SECTION_COUNT         2
        #define NUMBER_OF_FATS                 1
    #else                                                                // use FAT32 for large disk sizes
        #define BOOT_SECTOR_LOCATION           63                        // 0x3f
        #define BACKUP_ROOT_SECTOR             6
        #define BYTES_PER_SECTOR               512
        #define RESERVED_SECTION_COUNT         32
        #define NUMBER_OF_FATS                 1
    #endif
#endif
this also affects the default size, and why my MSD shows 2 mb size   line 385:
#if defined UTFAT12
    #define DISK_SIZE                      (2 * 1024 * 1024)             // 16Meg (maximum with FAT12)
    #define FAT_CLUSTER_MASK               FAT12_CLUSTER_MASK            // {46}
#else                                                                    // FAT32 used with larger disk sizes
    #define DISK_SIZE                      (8 * 1024 * 1024)             // 8Meg
    #define FAT_CLUSTER_MASK               FAT32_CLUSTER_MASK            // {46}
    #define FAT_SECTOR_COUNT               ((DISK_SIZE + ((4 * 1024 * 1024) - 1)) / (4 * 1024 * 1024))
#endif
This says the size of the MSD is hardcoded?

I'm convinced the USB MSD isn't gluing to the SPI.  I'm going to drop a bunch of hardware debug uart codes to read on a logic analyzer tomorrow. 

Just for clarity:
the proper configuration in config.h is:
  #define SPI_FILE_SYSTEM                                                // we have an external file system via SPI interface  *** definitely need this
  //#define FLASH_FILE_SYSTEM                                         // we have an internal file system in FLASH               *** Actually It seems we don't need this
    #define FLASH_ROUTINES                                              // supply flash routines                                              *** definitely need this
    #define SPI_FLASH_W25Q                                             // internal QSPI flash                                                  *** needed to add this

#if defined (SPI_FILE_SYSTEM) || defined (FLASH_FILE_SYSTEM) || defined (NVRAM) || defined INTERNAL_USER_FILES
    //#define ACTIVE_FILE_SYSTEM                   // Removed RJS 8/31/2023    // enable uFileSystem  ***this seems to mess with the MSD in the main application, doesn't work with this defined
#endif

also, I'm pretty sure I've got this correct  (config.h) starting 1693ish

    #else
   // #define SDCARD_SUPPORT                                       // SD-card interface (only choose one of these options at a time)   ** meaning either SDCARD  OR SPI_FAT_FLASH
    #endif
    #define SPI_FLASH_FAT                                              // SPI flash                                                                                        *** definitely need this
        #define SIMPLE_FLASH                                           // don't perform block management and wear-leveling                    *** definitely need this
      //  #define FLASH_FAT_MANAGEMENT_ADDRESS     (SIZE_OF_FLASH)                                                                                  *** not used 
    #if (defined ST_MB997A_DISCOVERY && defined DEV11)
        #define RENAME_SDCARD_FILE_AFTER_UPDATE                        // once new firmware has been copied from the SD card it will be automatically renamed
    #else
      //#define RENAME_SDCARD_FILE_AFTER_UPDATE                        // once new firmware has been copied from the SD card it will be automatically renamed
      #define DELETE_SDCARD_FILE_AFTER_UPDATE                          // once new firmware has been copied from the SD card it will be automatically deleted from the card
    #endif
    #if (defined SERIAL_INTERFACE && !defined REMOVE_SREC_LOADING)
      //  #define UTFAT_DISABLE_DEBUG_OUT    //9-1-2023 RJS removed           // disable general mass-storage output so that the SREC loader is not disturbed
    #endif
    #if (defined DELETE_SDCARD_FILE_AFTER_UPDATE || defined USE_USB_MSD)
        #define UTFAT_WRITE
    #endif


Thanks, 

Ray

[mark]

Hi Ray

>> #define ACTIVE_FILE_SYSTEM

This is used to enable the uFileSystem which tends to be used with the FTP/HTTP interfaces. However when no Ethernet is enable in the serial loader

#define _NO_FILE_INTERFACE                                           // code size optimisation

is set, which disables some of the support so that the size is optimised.



>> change line 217  from 64 to 476  #define UTASKER_APP_END   (unsigned char *)(UTASKER_APP_START + (476 * 1024)) // use entire chip

You may need to reduce the size by the application's parameter system size so that the parameters are not deleted when loading new code.

Otherwise I haven't been able to reproduce the project so it would be simpler if you send me your config.h and app_hw_kinetis.h files.

If I have understood correctly you are using USE_USB_MSD in the application (a USB-MSD device to SD card / SPI Flash), with the following configuration note:
            #define USE_USB_MSD                                          // needs SD card to compile (or alternatives FLASH_FAT / SPI_FLASH_FAT / FAT_EMULATION)

In the serial loader the same can be set but it looks to be dedicated to the SD card:
#define USE_USB_MSD                                              // full USB-MSD to SD card interface on USB (no emulated loader function) - requires SDCARD_SUPPORT (USB_MSD_DEVICE_LOADER can be disabled)

My initial feeling is that some addition code configuration may be required to allow the same operation.

If you send me the two header files it would be easier for me to check.

Regards

Mark