Update TODO part of readme
[lpctools] / check.c
1 /*********************************************************************
2  *
3  *   ISP (In-System Programming) companion tool for NXP LPC Microcontrollers
4  *
5  * This tool allows user-code computation and CRP protection check for NXP LPC
6  * microcontrollers.
7  *
8  *
9  *  Copyright (C) 2012 Nathael Pajani <nathael.pajani@nathael.net>
10  *
11  *  This program is free software: you can redistribute it and/or modify
12  *  it under the terms of the GNU General Public License as published by
13  *  the Free Software Foundation, either version 3 of the License, or
14  *  (at your option) any later version.
15  *
16  *  This program is distributed in the hope that it will be useful,
17  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  *  GNU General Public License for more details.
20  *
21  *  You should have received a copy of the GNU General Public License
22  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
23  *
24  *********************************************************************/
27 #include <stdlib.h> /* malloc, free */
28 #include <stdio.h>
29 #include <stdint.h>
31 #include <unistd.h> /* open, getopt, close, usleep */
32 #include <fcntl.h>
33 #include <sys/types.h>
34 #include <sys/stat.h>
36 #include <errno.h>
37 #include <getopt.h>
39 #include <termios.h> /* for serial config */
40 #include <ctype.h>
42 #include <string.h> /* strncmp, strlen, strdup */
44 #include "isp_utils.h"
46 #define PROG_NAME "LPC binary check"
47 #define VERSION   "1.07"
50 void help(char *prog_name)
51 {
52         fprintf(stderr, "---------------- "PROG_NAME" --------------------------------\n");
53         fprintf(stderr, "Usage: %s [options] [prog file name]\n" \
54                 "  Available options:\n" \
55                 "  \t -n | --no-user-code : do not compute a valid user code for exception vector 7\n" \
56                 "  \t -s | --skip-crp-verification : do not perform CRP code verification\n" \
57                 "  \t -h | --help : display this help\n" \
58                 "  \t -v | --version : display version information\n", prog_name);
59         fprintf(stderr, "-----------------------------------------------------------------------\n");
60 }
62 int trace_on = 0;
64 static int calc_user_code = 1; /* User code is computed by default */
65 static int check_crp = 1; /* CRP is checked by default */
67 int main(int argc, char** argv)
68 {
69         char* filename = NULL;
70         char* data = NULL;
71         struct stat stat_buffer;
72         int size = 0;
73         uint32_t* v = NULL; /* Used for checksum computing */
74         uint32_t cksum = 0;
75         uint32_t crp = 0;
76         int ret = 0;
78         /* parameter parsing */
79         while(1) {
80                 int option_index = 0;
81                 int c = 0;
83                 struct option long_options[] = {
84                         {"no-user-code", no_argument, 0, 'n'},
85                         {"skip-crp-verification", no_argument, 0, 's'},
86                         {"help", no_argument, 0, 'h'},
87                         {"version", no_argument, 0, 'v'},
88                         {0, 0, 0, 0}
89                 };
91                 c = getopt_long(argc, argv, "nshv", long_options, &option_index);
93                 /* no more options to parse */
94                 if (c == -1) break;
96                 switch (c) {
97                         /* n, user-code */
98                         case 'n':
99                                 calc_user_code = 0;
100                                 break;
102                         /* s, skip CRP verification */
103                         case 's':
104                                 check_crp = 0;
105                                 break;
107                         /* v, version */
108                         case 'v':
109                                 printf("%s Version %s\n", PROG_NAME, VERSION);
110                                 return 0;
111                                 break;
113                         /* h, help */
114                         case 'h':
115                         default:
116                                 help(argv[0]);
117                                 return -1;
118                 }
119         }
121         /* Parse remaining command line arguments (not options). It should be the binary file name */
122         if ((optind >= argc) || ((argc - optind) != 1)) {
123                 printf("Need one (and only one) file name to check.\n");
124                 return -1;
125         }
126         filename = argv[optind];
128         /* Get information on the file */
129         if (stat(filename, &stat_buffer) == -1) {
130                 perror("stat failed");
131                 printf("Unable to get informations on file \"%s\"\n", filename);
132                 return -2;
133         }
134         /* Allocate a buffer big enougth to get the CRP in it */
135         data = malloc(stat_buffer.st_size);
136         if (data == NULL) {
137                 printf("Unable to get a buffer to load the image!\n");
138                 return -2;
139         }
140         size = isp_file_to_buff(data, stat_buffer.st_size, filename);
141         if (size <= 0){
142                 free(data);
143                 return -2;
144         }
146         /* And check checksum of first 7 vectors if asked, according to section 21.3.3 of
147          * LPC11xx user's manual (UM10398) */
148         v = (uint32_t *)data;
149         cksum = 0 - v[0] - v[1] - v[2] - v[3] - v[4] - v[5] - v[6];
150         if (calc_user_code == 1) {
151                 v[7] = cksum;
152                 isp_buff_to_file(data, size, filename);
153                 printf("Checksum check done. File updated.\n");
154         } else if (cksum != v[7]) {
155                 printf("Checksum is 0x%08x, should be 0x%08x\n", v[7], cksum);
156                 ret = -3;
157         }
159         if (check_crp == 1) {
160                 crp = v[(CRP_OFFSET / 4)];
161                 printf("CRP : 0x%08x\n", crp);
162                 if ((crp == CRP_NO_ISP) || (crp == CRP_CRP1) || (crp == CRP_CRP2) || (crp == CRP_CRP3)) {
163                         printf("CRP : 0x%08x\n", crp);
164                         printf("The binary has CRP protection ativated, which violates GPLv3.\n");
165                         printf("Check the licence for the software you are about to flash.\n"); 
166                         ret = -4;
167                 }
168         }
170         free(data);
171         return ret;