Verify data after writing
[people/mcb30/gpxe.git] / src / drivers / nvs / nvs.c
1 /*
2  * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <stdint.h>
20 #include <string.h>
21 #include <errno.h>
22 #include <assert.h>
23 #include <gpxe/nvs.h>
24
25 /** @file
26  *
27  * Non-volatile storage
28  *
29  */
30
31 /**
32  * Read from non-volatile storage device
33  *
34  * @v nvs               NVS device
35  * @v address           Address from which to read
36  * @v data              Data buffer
37  * @v len               Length of data buffer
38  * @ret rc              Return status code
39  */
40 int nvs_read ( struct nvs_device *nvs, unsigned int address,
41                void *data, size_t len ) {
42         size_t frag_len;
43         int rc;
44
45         /* We don't even attempt to handle buffer lengths that aren't
46          * an integral number of words.
47          */
48         assert ( ( len & ( ( 1 << nvs->word_len_log2 ) - 1 ) ) == 0 );
49
50         while ( len ) {
51
52                 /* Calculate space remaining up to next block boundary */
53                 frag_len = ( ( nvs->block_size -
54                                ( address & ( nvs->block_size - 1 ) ) )
55                              << nvs->word_len_log2 );
56
57                 /* Limit to space remaining in buffer */
58                 if ( frag_len > len )
59                         frag_len = len;
60
61                 /* Read this portion of the buffer from the device */
62                 if ( ( rc = nvs->read ( nvs, address, data, frag_len ) ) != 0 )
63                         return rc;
64
65                 /* Update parameters */
66                 data += frag_len;
67                 address += ( frag_len >> nvs->word_len_log2 );
68                 len -= frag_len;
69         }
70
71         return 0;
72 }
73
74 /**
75  * Verify content of non-volatile storage device
76  *
77  * @v nvs               NVS device
78  * @v address           Address from which to read
79  * @v data              Data to compare against
80  * @v len               Length of data buffer
81  * @ret rc              Return status code
82  */
83 static int nvs_verify ( struct nvs_device *nvs, unsigned int address,
84                         const void *data, size_t len ) {
85         uint8_t read_data[len];
86         int rc;
87
88         /* Read data into temporary buffer */
89         if ( ( rc = nvs_read ( nvs, address, read_data, len ) ) != 0 )
90                 return rc;
91
92         /* Compare data */
93         if ( memcmp ( data, read_data, len ) != 0 ) {
94                 DBG ( "NVS %p verification failed at %#04x+%d\n",
95                       nvs, address, len );
96                 return -EINVAL;
97         }
98
99         return 0;
100 }
101
102 /**
103  * Write to non-volatile storage device
104  *
105  * @v nvs               NVS device
106  * @v address           Address to which to write
107  * @v data              Data buffer
108  * @v len               Length of data buffer
109  * @ret rc              Return status code
110  */
111 int nvs_write ( struct nvs_device *nvs, unsigned int address,
112                 const void *data, size_t len ) {
113         size_t frag_len;
114         int rc;
115
116         /* We don't even attempt to handle buffer lengths that aren't
117          * an integral number of words.
118          */
119         assert ( ( len & ( ( 1 << nvs->word_len_log2 ) - 1 ) ) == 0 );
120
121         while ( len ) {
122
123                 /* Calculate space remaining up to next block boundary */
124                 frag_len = ( ( nvs->block_size -
125                                ( address & ( nvs->block_size - 1 ) ) )
126                              << nvs->word_len_log2 );
127
128                 /* Limit to space remaining in buffer */
129                 if ( frag_len > len )
130                         frag_len = len;
131
132                 /* Write this portion of the buffer to the device */
133                 if ( ( rc = nvs->write ( nvs, address, data, frag_len ) ) != 0)
134                         return rc;
135
136                 /* Read back and verify data */
137                 if ( ( rc = nvs_verify ( nvs, address, data, frag_len ) ) != 0)
138                         return rc;
139
140                 /* Update parameters */
141                 data += frag_len;
142                 address += ( frag_len >> nvs->word_len_log2 );
143                 len -= frag_len;
144         }
145
146         return 0;
147 }