summaryrefslogtreecommitdiff
path: root/cleopatre/application/libspid/src/image.c
blob: 01c5fb813f5df61d9f91e6d2f526369e5eef03fd (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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
/* SPC300 bundle {{{
 *
 * Copyright (C) 2009 Spidcom
 *
 * <<<Licence>>>
 *
 * }}} */
/**
 * \file    application/libspid/src/image.c
 * \brief   firmware image management
 * \ingroup libspid
 *
 */

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <fcntl.h>
#include <sys/ioctl.h>
#include <unistd.h>
#include <libgen.h>
#include <syslog.h>
#include <mtd/mtd-user.h>
#include "libspid.h"

/**
 * Give informations on the stored firmware images : current,
 * alternate, #0 and #1.<BR>
 * The provided image descriptor structure is fill with requested
 * image infomration.<BR>
 * The device name of flash partition where image is stored is
 * put inside the provided mtd_name buffer. Buffer length must
 * be >= LIBSPID_MTD_NAME_MAX_LEN (16).
 *
 * \param type type of image to get information
 * \param image_desc pointer to structure where information is
 * filled
 * \param mtd_name buffer to get the mtd device name where the
 * requested image is stored.
 * \return error type (LIBSPID_SUCCESS if success)
 * \return LIBSPID_ERROR_PARAM: bad input parameters
 * \return LIBSPID_ERROR_NOT_FOUND: requested image not found
 * \return LIBSPID_ERROR_SYSTEM: system error, see errno
 */

libspid_error_t libspid_image_get_desc(libspid_image_desc_type_t type, spidcom_image_desc_t *image_desc, char *mtd_name)
{
    int fd0 = 0;
    int fd1 = 0;
    spidcom_image_desc_t image_desc_temp[2];
    char mtd_name_temp[2][32] = {{0}};
    int found_index = -1;
    char line_buffer[LIBSPID_CONFIG_LINE_MAX_LEN];
    char *strtok_ctx;
    int img_desc_0_found = 0;
    int img_desc_1_found = 0;
    FILE *fp;
    char *img_desc_mtd_num;
    spidcom_nvram_t nvram;

    if ( (image_desc == NULL) || (mtd_name == NULL) )
    {
        return LIBSPID_ERROR_PARAM;
    }

    if ( (type >= LIBSPID_IMAGE_DESC_TYPE_NB) )
    {
        return LIBSPID_ERROR_PARAM;
    }

    if ( LIBSPID_SUCCESS != libspid_system_get_nvram(&nvram) )
    {
        return LIBSPID_ERROR_SYSTEM;
    }

    if ( nvram.nb_images == 1  && ( type != LIBSPID_IMAGE_DESC_TYPE_0 && type != LIBSPID_IMAGE_DESC_TYPE_CURRENT ) )
    {
        return LIBSPID_ERROR_PARAM;
    }

    if( (fp = fopen (LIBSPID_SYSTEM_MTD_PATH, "r")) == NULL)
    {
        return LIBSPID_ERROR_SYSTEM;
    }
    while ( fgets(line_buffer, LIBSPID_CONFIG_LINE_MAX_LEN - 1, fp) != NULL )
    {
        if ( strstr(line_buffer, SPIDCOM_IMG_DESC_IMG_NAME_0) != NULL )
        {
            img_desc_0_found = 1;
            /* Extract mtd path from line mtd<num>: <size> <erasesize> "nvram" */
            img_desc_mtd_num = strtok_r(line_buffer, ": ", &strtok_ctx);
            sprintf(mtd_name_temp[0], "%s/%s", LIBSPID_DEV_PATH, img_desc_mtd_num);
        }

        else if ( nvram.nb_images > 1 && ( strstr(line_buffer, SPIDCOM_IMG_DESC_IMG_NAME_1) != NULL ) )
        {
            img_desc_1_found = 1;
            /* Extract mtd path from line mtd<num>: <size> <erasesize> "nvram" */
            img_desc_mtd_num = strtok_r(line_buffer, ": ", &strtok_ctx);
            sprintf(mtd_name_temp[1], "%s/%s",LIBSPID_DEV_PATH, img_desc_mtd_num);
        }
    }

    fclose (fp);

    if ( img_desc_0_found == 0 || (nvram.nb_images > 1 && img_desc_1_found == 0) )
    {
        return LIBSPID_ERROR_NOT_FOUND;
    }

    /* open the MTD devices for partition #0 and #1 */
    if ( (fd0 = open(mtd_name_temp[0], O_RDONLY)) < 0 )
    {
        return LIBSPID_ERROR_SYSTEM;
    }
    if ( nvram.nb_images > 1 && (fd1 = open(mtd_name_temp[1], O_RDONLY)) < 0 )
    {
        close(fd0);
        return LIBSPID_ERROR_SYSTEM;
    }

    /* get image descriptor infos from both MTD */
    if ( (read(fd0, &image_desc_temp[0], sizeof(spidcom_image_desc_t)) < (int)sizeof(spidcom_image_desc_t))
       || ( nvram.nb_images > 1 && ( read(fd1, &image_desc_temp[1], sizeof(spidcom_image_desc_t)) < (int)sizeof(spidcom_image_desc_t) ) ) )
    {
        close(fd0);
        if (nvram.nb_images > 1)
            close(fd1);
        return LIBSPID_ERROR_SYSTEM;
    }
    close(fd0);
    close(fd1);

    /* give asked type */
    switch(type)
    {
    case LIBSPID_IMAGE_DESC_TYPE_0 :
        if ( SPIDCOM_IMG_DESC_IS_VALID(image_desc_temp) )
        {
            found_index = 0;
        }
        break;

    case LIBSPID_IMAGE_DESC_TYPE_1:
        if ( SPIDCOM_IMG_DESC_IS_VALID(image_desc_temp + 1) )
        {
            found_index = 1;
        }
        break;

    case LIBSPID_IMAGE_DESC_TYPE_CURRENT:
    case LIBSPID_IMAGE_DESC_TYPE_ALTERNATE:
        if ((fp = fopen (LIBSPID_CUR_IMG_PROC_PATH, "r")) != NULL)
        {
            memset (line_buffer, 0, LIBSPID_CONFIG_LINE_MAX_LEN);
            if (fgets (line_buffer, LIBSPID_CONFIG_LINE_MAX_LEN - 1, fp) != NULL)
            {
                found_index = atoi (line_buffer);
                if (found_index >= 0 && found_index <= 1)
                {
                    /* give alternate index if asked */
                    if (type == LIBSPID_IMAGE_DESC_TYPE_ALTERNATE)
                    {
                        found_index = (found_index + 1) % 2;
                    }

                    fclose (fp);
                    break;
                }
            }

            fclose (fp);
        }

        /* check image validity */
        if ( nvram.nb_images == 1 )
        {
            found_index = 0;
        }
        else if ( !SPIDCOM_IMG_DESC_IS_VALID(image_desc_temp) )
        {
            found_index = 1;
        }
        else if ( !SPIDCOM_IMG_DESC_IS_VALID(image_desc_temp + 1) )
        {
            found_index = 0;
        }
        else
        {
            /* we have two images and both are valid, find the highest index */
            if ( image_desc_temp[0].index > image_desc_temp[1].index )
            {
                found_index = 0;
            }
            else
            {
                found_index = 1;
            }
        }
        /* give alternate index if asked */
        if ( type == LIBSPID_IMAGE_DESC_TYPE_ALTERNATE )
        {
            found_index = (found_index + 1) % 2;
        }
        break;

    default:
        /* hum : not possible */
        break;
    }
    mtd_name[0] = '\0';
    if (found_index >= 0)
    {
        strcpy(mtd_name, mtd_name_temp[found_index]);
    }

    if ( (found_index < 0) || !SPIDCOM_IMG_DESC_IS_VALID(image_desc_temp + found_index) )
    {
        return LIBSPID_ERROR_SYSTEM;
    }
    memcpy( image_desc, &image_desc_temp[found_index], sizeof(spidcom_image_desc_t) );

    return LIBSPID_SUCCESS;
}

/**
 * Get index of an image from its MTD partition.
 *
 * \param  mtd_path  Full path of MTD partition
           of the image for which index is wanted
 * \param  index  index to return, set to -1 if not found
 * \return error type (LIBSPID_SUCCESS if success)
 * \return LIBSPID_ERROR_PARAM: bad input parameters
 * \return LIBSPID_ERROR_NOT_FOUND: index not found
 * \return LIBSPID_ERROR_SYSTEM: system error, see errno
 */
libspid_error_t
libspid_image_get_index (const char *mtd_path, int *index)
{
    FILE *fp = NULL;
    char *mtd_partition = NULL;
    char mtd_path_tmp[32] = {0};
    char line_buffer[LIBSPID_CONFIG_LINE_MAX_LEN] = {0};
    int dummy;

    /* Check arguments */
    if ((NULL == mtd_path) || (NULL == index))
    {
        return LIBSPID_ERROR_PARAM;
    }

    /* Copy mtd_path not to modify it */
    memcpy (mtd_path_tmp, mtd_path, sizeof (mtd_path_tmp));

    /* Initialize index as not found */
    *index = -1;

    /* From full MTD path, get the MTD partition */
    mtd_partition = basename (mtd_path_tmp);

    /* From MTD partition, find the MTD name in file "/proc/mtd" */
    if ((fp = fopen (LIBSPID_SYSTEM_MTD_PATH, "r")) == NULL)
    {
        return LIBSPID_ERROR_SYSTEM;
    }
    while (fgets (line_buffer, LIBSPID_CONFIG_LINE_MAX_LEN - 1, fp) != NULL)
    {
        if (strstr (line_buffer, mtd_partition) != NULL)
        {
            /* Extract MTD name from line mtd<num>: <size> <erasesize> "name"
             * We search following name : "image <index>" */
            if (4 != sscanf (line_buffer, "mtd%d: %08x %08x \"image %d\"",
                &dummy, &dummy, &dummy, index))
            {
                fclose (fp);
                return LIBSPID_ERROR_NOT_FOUND;
            }
            break;
        }
    }
    fclose (fp);

    /* Check if index has been found */
    if (-1 == *index)
    {
        return LIBSPID_ERROR_NOT_FOUND;
    }

    return LIBSPID_SUCCESS;
}

/**
 * Select the current image firmware to boot on the next time.
 *
 * \param select the image to select for nrxt boot
 * \return error type (LIBSPID_SUCCESS if success)
 * \return LIBSPID_ERROR_PARAM: bad input parameters
 * \return LIBSPID_ERROR_NOT_FOUND: selected image is not valid
 * \return LIBSPID_ERROR_SYSTEM: system error, see errno
 */

libspid_error_t libspid_image_select(libspid_image_select_t select)
{
    int fd;
    spidcom_image_desc_t image_desc[2], *image_desc_ptr;
    char mtd_name[2][32], current_mtd_name[32];
    unsigned char *sector_data;
    //region_info_t reginfo;
    //char cmd_buffer[256];
    spidcom_nvram_t nvram;
#ifndef __UTESTS__
    volatile mtd_info_t meminfo;
    erase_info_t erase;
#else
    struct meminfo_utests
    {
        int erasesize;
    } meminfo;
#endif  /* __UTESTS__ */

    if ( (select >= LIBSPID_IMAGE_SELECT_NB) )
    {
        return LIBSPID_ERROR_PARAM;
    }

    if ( LIBSPID_SUCCESS != libspid_system_get_nvram(&nvram) )
    {
        return LIBSPID_ERROR_SYSTEM;
    }

    if ( nvram.nb_images == 1 )
    {
        if ( select != LIBSPID_IMAGE_SELECT_0 )
            return LIBSPID_ERROR_PARAM;
        else
            return LIBSPID_SUCCESS;
    }

    /* get the current partition mtd_name */
    if ( LIBSPID_SUCCESS != libspid_image_get_desc(LIBSPID_IMAGE_DESC_TYPE_CURRENT, image_desc, current_mtd_name) )
    {
        return LIBSPID_ERROR_SYSTEM;
    }

    /* fill table with index 0='the new selected', 1='the other' */
    switch(select)
    {
    case LIBSPID_IMAGE_SELECT_0:
        libspid_image_get_desc(LIBSPID_IMAGE_DESC_TYPE_0, image_desc, mtd_name[0]);
        libspid_image_get_desc(LIBSPID_IMAGE_DESC_TYPE_1, image_desc + 1, mtd_name[1]);
        break;
    case LIBSPID_IMAGE_SELECT_1:
        libspid_image_get_desc(LIBSPID_IMAGE_DESC_TYPE_1, image_desc, mtd_name[0]);
        libspid_image_get_desc(LIBSPID_IMAGE_DESC_TYPE_0, image_desc + 1, mtd_name[1]);
        break;
    case LIBSPID_IMAGE_SELECT_SWITCH:
        libspid_image_get_desc(LIBSPID_IMAGE_DESC_TYPE_ALTERNATE, image_desc, mtd_name[0]);
        libspid_image_get_desc(LIBSPID_IMAGE_DESC_TYPE_CURRENT, image_desc + 1, mtd_name[1]);
        break;
    default:
        return LIBSPID_ERROR_SYSTEM;
    }

    /* check the validity of selected partition */
    if (!image_desc[0].is_valid)
    {
        return LIBSPID_ERROR_SYSTEM;
    }

    /* check if we are selecting our current partition */
    if ( !strcmp(current_mtd_name, mtd_name[0]) )
    {
        /* no work to be done
         * bacause we are demanded to switch to the image
         * that we are actually already running */
        return LIBSPID_SUCCESS;
    }

    /* open the selected mtd partition */
    if ( (fd = open(mtd_name[0], O_RDWR)) < 0 )
    {
        return LIBSPID_ERROR_SYSTEM;
    }

#ifndef __UTESTS__
    /* get the flash block erase size */
    if ( ioctl(fd, MEMGETINFO, &meminfo) < 0 )
    {
        //syslog(LOG_WARNING, "%s: cannot get info from %s (errno=%d)", __FUNCTION__, mtd_name[0], errno);
        close(fd);
        return LIBSPID_ERROR_SYSTEM;
    }
#else
    meminfo.erasesize = 64000;  /* 64K sector */
#endif /* __UTESTS__ */

    /* allocate memory to copy the 1st sector of new selected partition */
    if ( (sector_data = malloc(meminfo.erasesize)) == NULL )
    {
        //syslog(LOG_WARNING, "%s: memory allocation of %d bytes failed (errno=%d)", __FUNCTION__, meminfo.erasesize, errno);
        close(fd);
        return LIBSPID_ERROR_SYSTEM;
    }

    /* read the 1st sector data */
    if ( read(fd, sector_data, meminfo.erasesize) < 0 )
    {
        free(sector_data);
        close(fd);
        return LIBSPID_ERROR_SYSTEM;
    }

    /* set the new index to alternate.index + 1 */
    image_desc_ptr = (spidcom_image_desc_t *)sector_data;
    image_desc_ptr->index = image_desc[1].index + 1;

#ifndef __UTESTS__
    /* erase the 1st sector */
    erase.start = 0;
    erase.length = meminfo.erasesize;
    if (ioctl(fd, MEMERASE, &erase) != 0)
    {
        //syslog(LOG_WARNING, "%s: flash erase of %s failed (errno=%d)", __FUNCTION__, mtd_name[0], errno);
        free(sector_data);
        close(fd);
        return LIBSPID_ERROR_SYSTEM;
    }
#endif /* __UTESTS__ */

    /* restore the save 1st sector */
    /*if((fd = open(mtd_name[0], O_RDWR)) < 0)
      {
      syslog(LOG_WARNING, "%s: cannot open %s to restore the 1st sector (errno=%d) !!!", __FUNCTION__, mtd_name[0], errno);
      free(sector_data);
      return -errno;
      }*/
    lseek(fd, 0, SEEK_SET);
    if (meminfo.erasesize != write (fd, sector_data, meminfo.erasesize))
    {
      close(fd);
      free(sector_data);
      return LIBSPID_ERROR_SYSTEM;
    }

    close(fd);
    free(sector_data);

    /* ok, new sector is selected */
    return LIBSPID_SUCCESS;
}

/**
 * Update the current image index.
 *
 * \param index the current image index new value
 * \param mtd_name the current image mtd path
 * \return error type (LIBSPID_SUCCESS if success)
 * \return LIBSPID_ERROR_SYSTEM: system error, see errno
 */
libspid_error_t libspid_image_update_current_index(uint32_t   index,
                                                   const char *mtd_name)
{
    int mtd, write_size;
    mtd_info_t meminfo;
    erase_info_t erase;
    char *sect;
    spidcom_image_desc_t *desc;

    if ((mtd = open (mtd_name, O_RDWR)) != -1)
    {
        /* Get sector size. */
        if (ioctl (mtd, MEMGETINFO, &meminfo) == -1 )
        {
            syslog (LOG_WARNING, "%s: cannot get info from %s", __FUNCTION__, mtd_name);
            close (mtd);
            return LIBSPID_ERROR_SYSTEM;
        }

        /* Retrieve first sector. */
        if ((sect = malloc (meminfo.erasesize)) == NULL)
        {
            syslog (LOG_WARNING, "%s: cannot allocate memory for MTD read", __FUNCTION__);
            close (mtd);
            return LIBSPID_ERROR_SYSTEM;
        }
        if ((read (mtd, sect, meminfo.erasesize)) != (int) meminfo.erasesize)
        {
            syslog (LOG_WARNING, "%s: mtd read failed", __FUNCTION__);
            free (sect);
            close (mtd);
            return LIBSPID_ERROR_SYSTEM;
        }

        /* Write index */
        desc = (spidcom_image_desc_t *) sect;
        desc->index = index;

        /* Erase first block */
        erase.start = 0;
        erase.length = meminfo.erasesize;

        if (ioctl (mtd, MEMERASE, &erase) == -1)
        {
            syslog (LOG_WARNING, "%s: flash erase failed", __FUNCTION__);
            close (mtd);
            free (sect);
            return LIBSPID_ERROR_SYSTEM;
        }

        /* Write first block */
        lseek (mtd, 0, SEEK_SET);
        write_size = write (mtd, sect, meminfo.erasesize);
        free (sect);
        close (mtd);

        if (write_size != (int) meminfo.erasesize)
        {
            syslog (LOG_ERR, "%s: flash write failed", __FUNCTION__);
            return LIBSPID_ERROR_SYSTEM;
        }
    }
    else
    {
        syslog (LOG_WARNING, "%s: Unable to open %s", __FUNCTION__, mtd_name);
        return LIBSPID_ERROR_SYSTEM;
    }
    return LIBSPID_SUCCESS;
}