tools/examples/spiflash/erase_write_read/main.c

   1 /**************************************************************************/
   2 /*!
   3     @file     main.c
   4     @author   K. Townsend (microBuilder.eu)
   5
   6     @section LICENSE
   7
   8     Software License Agreement (BSD License)
   9
  10     Copyright (c) 2011, microBuilder SARL
  11     All rights reserved.
  12
  13     Redistribution and use in source and binary forms, with or without
  14     modification, are permitted provided that the following conditions are met:
  15     1. Redistributions of source code must retain the above copyright
  16     notice, this list of conditions and the following disclaimer.
  17     2. Redistributions in binary form must reproduce the above copyright
  18     notice, this list of conditions and the following disclaimer in the
  19     documentation and/or other materials provided with the distribution.
  20     3. Neither the name of the copyright holders nor the
  21     names of its contributors may be used to endorse or promote products
  22     derived from this software without specific prior written permission.
  23
  24     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
  25     EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  26     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  27     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
  28     DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  29     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  30     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  31     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  32     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  33     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34 */
  35 /**************************************************************************/
  36 #include <stdlib.h>
  37 #include <stdio.h>
  38 #include <string.h>
  39
  40 #include "projectconfig.h"
  41 #include "sysinit.h"
  42
  43 #include "core/gpio/gpio.h"
  44 #include "core/systick/systick.h"
  45 #include "drivers/storage/spiflash/spiflash.h"
  46
  47 #ifdef CFG_INTERFACE
  48   #include "core/cmd/cmd.h"
  49 #endif
  50
  51 /**************************************************************************/
  52 /*!
  53     Main program entry point.  After reset, normal code execution will
  54     begin here.
  55 */
  56 /**************************************************************************/
  57 int main(void)
  58 {
  59   // Configure cpu and mandatory peripherals
  60   systemInit();
  61
  62   spiflashError_e error;
  63   uint8_t buffer[256];
  64
  65   // Wait a few seconds to let people connect to USB CDC to see the output
  66   systickDelay(5000);
  67
  68   // Initialise SPI, etc.
  69   printf("Initialising flash\r\n");
  70   spiflashInit();
  71
  72   printf("Erasing sector 0 (page 0..15)\r\n");
  73   error = spiflashEraseSector (0);
  74   if (error)
  75   {
  76     // Check what went wrong
  77     switch (error)
  78     {
  79       case SPIFLASH_ERROR_ADDROUTOFRANGE:
  80         // Specified starting address is out of range
  81         break;
  82       case SPIFLASH_ERROR_TIMEOUT_READY:
  83         // Timeout waiting for ready status (can be pre or post write)
  84         break;
  85       case SPIFLASH_ERROR_PROTECTIONERR:
  86         // Flash is write protected
  87         break;
  88     }
  89   }
  90
  91   printf("Writing 8 bytes to page 0 starting at address 0x04 (byte 5)\r\n");
  92   buffer[0] = 0x12;
  93   buffer[1] = 0x34;
  94   buffer[2] = 0x56;
  95   buffer[3] = 0x78;
  96   buffer[4] = 0xAB;
  97   buffer[5] = 0xCD;
  98   buffer[6] = 0xEF;
  99   buffer[7] = 0xAA;
 100   error = spiflashWritePage (0x04, buffer, 8);
 101   if (error)
 102   {
 103     // Check what went wrong
 104     switch (error)
 105     {
 106       case SPIFLASH_ERROR_ADDROUTOFRANGE:
 107         // Specified starting address is out of range
 108         break;
 109       case SPIFLASH_ERROR_DATAEXCEEDSPAGESIZE:
 110         // Supplied data exceeds max page size
 111         break;
 112       case SPIFLASH_ERROR_PAGEWRITEOVERFLOW:
 113         // The data length plus the start address offset exceeeds page limits
 114         break;
 115       case SPIFLASH_ERROR_TIMEOUT_READY:
 116         // Timeout waiting for ready status (can be pre or post write)
 117         break;
 118       case SPIFLASH_ERROR_PROTECTIONERR:
 119         // Unable to set write latch
 120         break;
 121     }
 122   }
 123
 124   printf("Reading 16 bytes from page 1 (bytes 0..15)\r\n");
 125   // Clear buffer just to prove the point
 126   buffer[0] = 0;
 127   buffer[1] = 0;
 128   buffer[2] = 0;
 129   buffer[3] = 0;
 130   buffer[4] = 0;
 131   buffer[5] = 0;
 132   buffer[6] = 0;
 133   buffer[7] = 0;
 134   buffer[8] = 0;
 135   buffer[9] = 0;
 136   buffer[10] = 0;
 137   buffer[11] = 0;
 138   buffer[12] = 0;
 139   buffer[13] = 0;
 140   buffer[14] = 0;
 141   buffer[15] = 0;
 142   error = spiflashReadBuffer (0, buffer, 16);
 143   if (error)
 144   {
 145     // Check what went wrong
 146     switch (error)
 147     {
 148       case SPIFLASH_ERROR_ADDROUTOFRANGE:
 149         // Specified starting address is out of range
 150         break;
 151       case SPIFLASH_ERROR_TIMEOUT_READY:
 152         // Timed out waiting for flash to return ready state
 153         break;
 154       case SPIFLASH_ERROR_ADDROVERFLOW:
 155         // Ran over the upper address during read
 156         break;
 157     }
 158   }
 159
 160   // Display read results
 161   printf("0x%02X 0x%02X 0x%02X 0x%02X 0x%02X 0x%02X 0x%02X 0x%02X 0x%02X 0x%02X 0x%02X 0x%02X 0x%02X 0x%02X 0x%02X 0x%02X %s", buffer[0], buffer[1], buffer[2], buffer[3], buffer[4], buffer[5], buffer[6], buffer[7], buffer[8], buffer[9], buffer[10], buffer[11], buffer[12], buffer[13], buffer[14], buffer[15], CFG_PRINTF_NEWLINE);
 162
 163   while(1)
 164   {
 165   }
 166
 167   return 0;
 168 }