summaryrefslogtreecommitdiff
path: root/digital/avr/modules/flash/flash.avr.c
blob: 7b563bc6e328d512d9b1bf5f0939673465ea69ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
/* flash.c */
/*  {{{
 *
 * Copyright (C) 2008 NĂ©lio Laranjeiro
 *
 * APBTeam:
 *        Web: http://apbteam.org/
 *      Email: team AT apbteam DOT org
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 * }}} */
#include "flash.h"
#include "modules/proto/proto.h"
#include "modules/spi/spi.h"
#include "modules/utils/utils.h"

#define FLASH_LOG_PAGE_SIZE 0x80000
#define FLASH_LOG_BUFFER_SIZE 128

/** Flash access.
 * The flash contains an address of 21 bits in a range from 0x0-0x1fffff.
 * This function shall access the memory directly by the SPI.
 * \param  addr  the address to provide to the flash memory.
 */
void
flash_address (uint32_t addr)
{
    /* The address must be sent */
    spi_send ((addr >> 16) & 0x1f);
    spi_send (addr >> 8);
    spi_send (addr);
}

/** Erase the memory.
 * \param  erase_type  the erase type..
 * \param  start_addr  the start address.
 */
void
flash_erase (uint8_t cmd, uint32_t start_addr)
{
    flash_send_command (FLASH_WREN);

    AC_FLASH_PORT &= ~_BV(AC_FLASH_BIT_SS);
    /* send the command. */
    spi_send (cmd);

    /* verify if the cmd is the full erase. */
    if (cmd != FLASH_ERASE_FULL)
      {
        /* Send the start address */
        flash_address (start_addr);
      }
    AC_FLASH_PORT |= _BV(AC_FLASH_BIT_SS);

    while (flash_is_busy());
}

/* Send a flash command to the flash memory (only a command).
 * \param  cmd  the command to send.
 */
void
flash_send_command (uint8_t cmd)
{
    AC_FLASH_PORT &= ~_BV(AC_FLASH_BIT_SS);
    spi_send (cmd);
    AC_FLASH_PORT |= _BV(AC_FLASH_BIT_SS);
}


/** Poll the busy bit in the Software Status Register of the flash memory.
 * \return  the status register.
 */
uint8_t
flash_read_status (void)
{
    uint8_t res;

    AC_FLASH_PORT &= ~_BV(AC_FLASH_BIT_SS);
    spi_send (FLASH_RDSR);
    res = spi_recv();
    AC_FLASH_PORT |= _BV(AC_FLASH_BIT_SS);

    return res;
}

/** Initialise the flash memory.
 * \return true if the flash is present, false otherwise.
 */
uint8_t
flash_init (void)
{
    uint8_t rsp[3];

    AC_FLASH_PORT |= _BV(AC_FLASH_BIT_SS);
    AC_FLASH_DDR |= _BV(AC_FLASH_BIT_SS);

    /* send the read-ID instruction. */
    spi_init (SPI_MASTER, SPI_CPOL_FALLING | SPI_CPHA_SETUP, SPI_MSB_FIRST,
	      SPI_FOSC_DIV16);

    AC_FLASH_PORT &= ~_BV(AC_FLASH_BIT_SS);
    spi_send (FLASH_READ_ID);
    rsp[0] = spi_recv ();
    rsp[1] = spi_recv ();
    rsp[2] = spi_recv ();
    AC_FLASH_PORT |= _BV(AC_FLASH_BIT_SS);

    if (rsp[0] != 0xBF)
        return 0;

    proto_send3b ('f',rsp[0], rsp[1], rsp[2]);

    if (flash_status_aai())
      {
        flash_send_command (FLASH_WEDI);
      }

    /* Enables the flash to be writable. */
    flash_send_command (FLASH_WREN);

    AC_FLASH_PORT &= ~_BV(AC_FLASH_BIT_SS);
    spi_send (FLASH_WRSR);
    spi_send (0);
    AC_FLASH_PORT |= _BV(AC_FLASH_BIT_SS);

    /* Read the flash status. */
    proto_send1b ('s', flash_read_status());

    return 1;
}

/** Write in the flash byte provided in parameter.
 * \param  data  the buffer to store the data.
 */
void
flash_write (uint32_t addr, uint8_t data)
{
    while (flash_is_busy ());
    flash_send_command (FLASH_WREN);

    AC_FLASH_PORT &= ~_BV(AC_FLASH_BIT_SS);
    /* Write instruction. */
    spi_send (FLASH_WRITE);
    flash_address (addr);
    spi_send (data);
    AC_FLASH_PORT |= _BV(AC_FLASH_BIT_SS);

    /* Wait for the flash until it is busy */
    while (flash_is_busy());
}

/** Read the data at the address provided.
 * \return  the data read.
 */
uint8_t
flash_read (uint32_t addr)
{
    uint8_t data;

    while (flash_is_busy ());
    AC_FLASH_PORT &= ~_BV(AC_FLASH_BIT_SS);
    /* Send the read instruction. */
    spi_send (FLASH_READ);
    flash_address (addr);
    data = spi_recv ();
    AC_FLASH_PORT |= _BV(AC_FLASH_BIT_SS);
    while (flash_is_busy ());
    return data;
}

/** Read a data from the flash memory from the address provided and for a
 * length of the number of bytes provided.
 * \param  address at which the data should be read.
 * \param  buffer  the buffer to fill with the read data.
 * \param  length  the length of the data to read.
 *
 */
void
flash_read_array (uint32_t addr, uint8_t *buffer, uint32_t length)
{
    uint8_t i;

    while (flash_is_busy ());
    AC_FLASH_PORT &= ~_BV(AC_FLASH_BIT_SS);
    spi_send (FLASH_READ);
    flash_address (addr);
    for (i = 0; i < length; i++)
      {
        buffer[i] = spi_recv ();
      }
    AC_FLASH_PORT |= _BV(AC_FLASH_BIT_SS);
    while (flash_is_busy ());
}

/** Write in the flash byte provided in parameter.
 * \param  addr  the address to store the data.
 * \param  data  the array to store.
 * \param  length  the array length
 */
void
flash_write_array (uint32_t addr, uint8_t *data, uint32_t length)
{
    uint32_t i;

    for (i = 0; i < length; i++)
      {
        flash_write (addr + i, data[i]);
      }
}

int8_t
flash_log (uint8_t size, uint8_t *args)
{
    uint8_t buf[FLASH_LOG_BUFFER_SIZE+1];
    int8_t error = 0x0;
    uint32_t addr = 0;

    if (size >= 4)
	addr = (((uint32_t) args[1]) << 16)
	    | (((uint32_t) args[2]) << 8) | args[3];

    switch (args[0])
      {
      case FLASH_CMD_INIT:
	error = !flash_init ();
	proto_send1b ('s', error ? 0 : 1);
	break;
      case FLASH_CMD_READ:
	if ((size == 5)
	    && (args[4] <= sizeof(buf)))
	  {
	    flash_read_array (addr, buf, args[4]);
	    proto_send ('r', args[4], buf);
	    error = 0;
	  }
	else if (size == 4)
	  {
	    proto_send1b ('r', flash_read (addr));
	    error = 0;
	  }
	else
	    error = 2;
	break;
      default:
	return 3;
      }

    return error;
}