FreeCalypso > hg > freecalypso-tools
comparison loadtools/loadtool.help @ 996:162d2cf394e2
fc-loadtool help: document new commands for sector lock/unlock
| author | Mychaela Falconia <falcon@freecalypso.org> |
|---|---|
| date | Sun, 03 Dec 2023 23:00:04 +0000 |
| parents | 74024eb17e04 |
| children | 11391cb6bdc0 |
comparison
equal
deleted
inserted
replaced
| 995:74024eb17e04 | 996:162d2cf394e2 |
|---|---|
| 168 flash reset Reset flash chip to read array mode | 168 flash reset Reset flash chip to read array mode |
| 169 flash sectors Display the list of flash sector addresses and sizes | 169 flash sectors Display the list of flash sector addresses and sizes |
| 170 flash status Intel-style flash only: read Status Register | 170 flash status Intel-style flash only: read Status Register |
| 171 flash unlock Intel-style flash only: unlock flash sectors | 171 flash unlock Intel-style flash only: unlock flash sectors |
| 172 | 172 |
| 173 Additional operations for select Spansion and Samsung flash chips: | |
| 174 | |
| 175 flash lock-state Retrieve and display sector write-protection state | |
| 176 flash ppb-program Program Persistent Protection Bit for one sector | |
| 177 flash ppb-program-all Program all PPBs in the addressed flash bank | |
| 178 flash ppb-erase-all Erase all PPBs in the flash chip, unlocking all sectors | |
| 179 | |
| 173 Additional operations for Compal targets only: | 180 Additional operations for Compal targets only: |
| 174 | 181 |
| 175 flash compal-imei Read IMEI from OTP protection register | 182 flash compal-imei Read IMEI from OTP protection register |
| 176 flash erase-program-boot Erase and reprogram the boot sector | 183 flash erase-program-boot Erase and reprogram the boot sector |
| 177 | 184 |
| 275 | 282 |
| 276 In previous versions this command performed flash ID checks and displayed | 283 In previous versions this command performed flash ID checks and displayed |
| 277 geometry information; these functions have been moved to the new flash id and | 284 geometry information; these functions have been moved to the new flash id and |
| 278 flash geom commands. | 285 flash geom commands. |
| 279 | 286 |
| 287 === flash:lock-state | |
| 288 This command is only implemented for certain specific Spansion and Samsung | |
| 289 flash chip types that have lockable sectors, i.e., an ability to write-protect | |
| 290 certain flash sectors in a persistent, non-volatile manner. This command | |
| 291 retrieves and displays the lock state of every sector in the addressed flash | |
| 292 bank, as well as some chip-global lock status words. (The details are highly | |
| 293 chip-dependent.) | |
| 294 | |
| 295 In the case of 16 MiB flash chips, you need to execute flash lock-state to see | |
| 296 the lock state of sectors in the first flash bank and flash2 lock-state to see | |
| 297 the lock state of sectors in the second flash bank. | |
| 298 | |
| 299 === flash:ppb-program | |
| 300 flash[2] ppb-program sector-offset | |
| 301 | |
| 302 This command (implemented only for certain specific Spansion and Samsung flash | |
| 303 chip types) programs the Persistent Protection Bit (PPB) for the specified | |
| 304 sector, causing that sector to become persistently write-protected. Note that | |
| 305 on many flash chips sectors are aggregated into groups for the purpose of write | |
| 306 protection, with a group of up to 4 sectors sharing the same PPB - once that | |
| 307 per-group PPB is programmed, all sectors in that group become write-protected. | |
| 308 | |
| 309 Use flash ppb-erase-all command to clear all write protection locks created by | |
| 310 this command. | |
| 311 | |
| 312 === flash:ppb-program-all | |
| 313 This command is implemented only for those flash chip types whose PPB program | |
| 314 and erase commands follow the model of Spansion PL-J, rather than that of | |
| 315 Spansion PL-N. It programs all PPBs that reside in the addressed flash bank, | |
| 316 which will be the entire chip in the case of S71PL064J or half of the chip in | |
| 317 the case of S71PL129J or its Samsung equivalent. There is no anticipated need | |
| 318 for this command to ever be invoked by end users of fc-loadtool - instead it is | |
| 319 best seen as a made-accessible internal function of the tool, the internal | |
| 320 function that is primarily needed as part of flash ppb-erase-all implementation. | |
| 321 | |
| 322 === flash:ppb-erase-all | |
| 323 This command erases the special-purpose non-volatile memory element inside the | |
| 324 flash chip that stores all Persistent Protection Bits (PPBs) for this chip. | |
| 325 Because the erased state of a PPB corresponds to the associated flash sector or | |
| 326 group of sectors being unlocked, the present operation clears all write | |
| 327 protection locks in the entire chip, making all flash unlocked. | |
| 328 | |
| 329 Special note for 16 MiB flash chips: because there is only one dedicated NV | |
| 330 memory element in the entire flash chip for storing all PPBs, erasable only as | |
| 331 a unit, this command operates on the entire chip rather than per-bank. There | |
| 332 is no flash2 ppb-erase-all command for this reason. | |
| 333 | |
| 280 === flash:program-bin | 334 === flash:program-bin |
| 281 flash[2] program-bin flash-offset binfile [file-offset [length]] | 335 flash[2] program-bin flash-offset binfile [file-offset [length]] |
| 282 | 336 |
| 283 This command programs flash, using a binary file as the data source. One must | 337 This command programs flash, using a binary file as the data source. One must |
| 284 always specify the starting flash offset (from the base address of the flash | 338 always specify the starting flash offset (from the base address of the flash |