mbed support for LPC4088 Display Module
Dependencies: DM_FATFileSystem DM_HttpServer DM_USBHost EthernetInterface USBDevice mbed-rpc mbed-rtos mbed-src
Fork of DMSupport by
Bios/BiosLoader.cpp@24:9a677afc86f1, 2015-01-17 (annotated)
- Committer:
- embeddedartists
- Date:
- Sat Jan 17 14:12:37 2015 +0100
- Revision:
- 24:9a677afc86f1
- Parent:
- 22:1a58a518435c
- Child:
- 26:a65fbb4bde5c
- Added string parameter to the BIOS debug function to be able to print information about which BIOS_BOARD is selected
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
embeddedartists | 22:1a58a518435c | 1 | /* |
embeddedartists | 22:1a58a518435c | 2 | * Copyright 2014 Embedded Artists AB |
embeddedartists | 22:1a58a518435c | 3 | * |
embeddedartists | 22:1a58a518435c | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
embeddedartists | 22:1a58a518435c | 5 | * you may not use this file except in compliance with the License. |
embeddedartists | 22:1a58a518435c | 6 | * You may obtain a copy of the License at |
embeddedartists | 22:1a58a518435c | 7 | * |
embeddedartists | 22:1a58a518435c | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
embeddedartists | 22:1a58a518435c | 9 | * |
embeddedartists | 22:1a58a518435c | 10 | * Unless required by applicable law or agreed to in writing, software |
embeddedartists | 22:1a58a518435c | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
embeddedartists | 22:1a58a518435c | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
embeddedartists | 22:1a58a518435c | 13 | * See the License for the specific language governing permissions and |
embeddedartists | 22:1a58a518435c | 14 | * limitations under the License. |
embeddedartists | 22:1a58a518435c | 15 | */ |
embeddedartists | 22:1a58a518435c | 16 | |
embeddedartists | 22:1a58a518435c | 17 | #include "mbed.h" |
embeddedartists | 22:1a58a518435c | 18 | #include "BiosLoader.h" |
embeddedartists | 22:1a58a518435c | 19 | #include "DMBoard.h" |
embeddedartists | 22:1a58a518435c | 20 | #include "BiosEEPROM.h" |
embeddedartists | 22:1a58a518435c | 21 | #include "crc.h" |
embeddedartists | 22:1a58a518435c | 22 | #include "bios.h" |
embeddedartists | 22:1a58a518435c | 23 | |
embeddedartists | 22:1a58a518435c | 24 | #if defined(DM_BOARD_BIOS_DEVELOPMENT) |
embeddedartists | 22:1a58a518435c | 25 | #ifdef __cplusplus |
embeddedartists | 22:1a58a518435c | 26 | extern "C" { |
embeddedartists | 22:1a58a518435c | 27 | #endif |
embeddedartists | 24:9a677afc86f1 | 28 | void bios_debug_aid(bios_header_t* header, const char** pMsg); |
embeddedartists | 22:1a58a518435c | 29 | #ifdef __cplusplus |
embeddedartists | 22:1a58a518435c | 30 | } |
embeddedartists | 22:1a58a518435c | 31 | #endif |
embeddedartists | 22:1a58a518435c | 32 | #endif |
embeddedartists | 22:1a58a518435c | 33 | |
embeddedartists | 22:1a58a518435c | 34 | /****************************************************************************** |
embeddedartists | 22:1a58a518435c | 35 | * Defines and typedefs |
embeddedartists | 22:1a58a518435c | 36 | *****************************************************************************/ |
embeddedartists | 22:1a58a518435c | 37 | |
embeddedartists | 22:1a58a518435c | 38 | #define MOVE_POINTER(__x, __off) ( ( (uint32_t*)(__x) ) = (uint32_t*)( (uint32_t)(__x) + (__off) ) ) |
embeddedartists | 22:1a58a518435c | 39 | |
embeddedartists | 22:1a58a518435c | 40 | /* |
embeddedartists | 22:1a58a518435c | 41 | * Make sure that we reserve at least this amount of RAM for future |
embeddedartists | 22:1a58a518435c | 42 | * expansion of the BIOS. This prevents the user from squeezing out |
embeddedartists | 22:1a58a518435c | 43 | * the last drop of available RAM in his application. |
embeddedartists | 22:1a58a518435c | 44 | */ |
embeddedartists | 22:1a58a518435c | 45 | #define BIOS_RESERVED_CHUNK 0x1000 |
embeddedartists | 22:1a58a518435c | 46 | #define BIOS_MAX_SIZE 0x100000 |
embeddedartists | 22:1a58a518435c | 47 | #ifndef MAX |
embeddedartists | 22:1a58a518435c | 48 | #define MAX(__a, __b) (((__a)>(__b))?(__a):(__b)) |
embeddedartists | 22:1a58a518435c | 49 | #endif |
embeddedartists | 22:1a58a518435c | 50 | |
embeddedartists | 22:1a58a518435c | 51 | |
embeddedartists | 22:1a58a518435c | 52 | /****************************************************************************** |
embeddedartists | 22:1a58a518435c | 53 | * Local variables |
embeddedartists | 22:1a58a518435c | 54 | *****************************************************************************/ |
embeddedartists | 22:1a58a518435c | 55 | |
embeddedartists | 22:1a58a518435c | 56 | |
embeddedartists | 22:1a58a518435c | 57 | /****************************************************************************** |
embeddedartists | 22:1a58a518435c | 58 | * Private Functions |
embeddedartists | 22:1a58a518435c | 59 | *****************************************************************************/ |
embeddedartists | 22:1a58a518435c | 60 | |
embeddedartists | 22:1a58a518435c | 61 | // Function called from the BIOS |
embeddedartists | 22:1a58a518435c | 62 | static uint32_t readTimeMs() |
embeddedartists | 22:1a58a518435c | 63 | { |
embeddedartists | 22:1a58a518435c | 64 | return us_ticker_read()/1000; |
embeddedartists | 22:1a58a518435c | 65 | } |
embeddedartists | 22:1a58a518435c | 66 | |
embeddedartists | 22:1a58a518435c | 67 | |
embeddedartists | 22:1a58a518435c | 68 | BiosLoader::BiosLoader() : |
embeddedartists | 22:1a58a518435c | 69 | _initialized(false), |
embeddedartists | 22:1a58a518435c | 70 | _biosData(NULL), |
embeddedartists | 22:1a58a518435c | 71 | _conf(NULL), |
embeddedartists | 22:1a58a518435c | 72 | _confSize(0) |
embeddedartists | 22:1a58a518435c | 73 | { |
embeddedartists | 22:1a58a518435c | 74 | } |
embeddedartists | 22:1a58a518435c | 75 | |
embeddedartists | 22:1a58a518435c | 76 | BiosLoader::~BiosLoader() |
embeddedartists | 22:1a58a518435c | 77 | { |
embeddedartists | 22:1a58a518435c | 78 | if (_biosData != NULL) { |
embeddedartists | 22:1a58a518435c | 79 | free(_biosData); |
embeddedartists | 22:1a58a518435c | 80 | _biosData = NULL; |
embeddedartists | 22:1a58a518435c | 81 | } |
embeddedartists | 22:1a58a518435c | 82 | if (_conf != NULL) { |
embeddedartists | 22:1a58a518435c | 83 | free(_conf); |
embeddedartists | 22:1a58a518435c | 84 | _conf = NULL; |
embeddedartists | 22:1a58a518435c | 85 | _confSize = 0; |
embeddedartists | 22:1a58a518435c | 86 | } |
embeddedartists | 22:1a58a518435c | 87 | } |
embeddedartists | 22:1a58a518435c | 88 | |
embeddedartists | 22:1a58a518435c | 89 | DMBoard::BoardError BiosLoader::readBIOS(uint8_t** data, uint32_t* size) |
embeddedartists | 22:1a58a518435c | 90 | { |
embeddedartists | 22:1a58a518435c | 91 | DMBoard::BoardError err = DMBoard::Ok; |
embeddedartists | 22:1a58a518435c | 92 | BiosEEPROM eeprom; |
embeddedartists | 22:1a58a518435c | 93 | file_header_t fh; |
embeddedartists | 22:1a58a518435c | 94 | |
embeddedartists | 22:1a58a518435c | 95 | if (_conf != NULL) { |
embeddedartists | 22:1a58a518435c | 96 | *data = _conf; |
embeddedartists | 22:1a58a518435c | 97 | *size = _confSize; |
embeddedartists | 22:1a58a518435c | 98 | return DMBoard::Ok; |
embeddedartists | 22:1a58a518435c | 99 | } |
embeddedartists | 22:1a58a518435c | 100 | |
embeddedartists | 22:1a58a518435c | 101 | do { |
embeddedartists | 22:1a58a518435c | 102 | if (!eeprom.read(0, (char*)&fh, sizeof(file_header_t))) { |
embeddedartists | 22:1a58a518435c | 103 | resetI2C(); |
embeddedartists | 22:1a58a518435c | 104 | if (!eeprom.read(0, (char*)&fh, sizeof(file_header_t))) { |
embeddedartists | 22:1a58a518435c | 105 | err = DMBoard::BiosStorageError; |
embeddedartists | 22:1a58a518435c | 106 | break; |
embeddedartists | 22:1a58a518435c | 107 | } |
embeddedartists | 22:1a58a518435c | 108 | } |
embeddedartists | 22:1a58a518435c | 109 | |
embeddedartists | 22:1a58a518435c | 110 | if (fh.magic != BIOS_MAGIC) { |
embeddedartists | 22:1a58a518435c | 111 | err = DMBoard::BiosInvalidError; |
embeddedartists | 22:1a58a518435c | 112 | break; |
embeddedartists | 22:1a58a518435c | 113 | } |
embeddedartists | 22:1a58a518435c | 114 | |
embeddedartists | 22:1a58a518435c | 115 | if (fh.version != BIOS_VER) { |
embeddedartists | 22:1a58a518435c | 116 | err = DMBoard::BiosVersionError; |
embeddedartists | 22:1a58a518435c | 117 | break; |
embeddedartists | 22:1a58a518435c | 118 | } |
embeddedartists | 22:1a58a518435c | 119 | |
embeddedartists | 22:1a58a518435c | 120 | if ((fh.headerSize + fh.size) > BIOS_MAX_SIZE) { |
embeddedartists | 22:1a58a518435c | 121 | err = DMBoard::BiosInvalidError; |
embeddedartists | 22:1a58a518435c | 122 | break; |
embeddedartists | 22:1a58a518435c | 123 | } |
embeddedartists | 22:1a58a518435c | 124 | |
embeddedartists | 22:1a58a518435c | 125 | _confSize = fh.headerSize + fh.size; |
embeddedartists | 22:1a58a518435c | 126 | _conf = (uint8_t*)malloc(MAX(_confSize,BIOS_RESERVED_CHUNK)); |
embeddedartists | 22:1a58a518435c | 127 | if (_conf == NULL) { |
embeddedartists | 22:1a58a518435c | 128 | _confSize = 0; |
embeddedartists | 22:1a58a518435c | 129 | err = DMBoard::MemoryError; |
embeddedartists | 22:1a58a518435c | 130 | break; |
embeddedartists | 22:1a58a518435c | 131 | } |
embeddedartists | 22:1a58a518435c | 132 | |
embeddedartists | 22:1a58a518435c | 133 | if (!eeprom.read(0, (char*)_conf, _confSize)) { |
embeddedartists | 22:1a58a518435c | 134 | err = DMBoard::BiosStorageError; |
embeddedartists | 22:1a58a518435c | 135 | break; |
embeddedartists | 22:1a58a518435c | 136 | } |
embeddedartists | 22:1a58a518435c | 137 | |
embeddedartists | 22:1a58a518435c | 138 | uint32_t crc = crc_Buffer((uint32_t*)(&_conf[fh.headerSize]), fh.size/4); |
embeddedartists | 22:1a58a518435c | 139 | if (crc != fh.crc) { |
embeddedartists | 22:1a58a518435c | 140 | err = DMBoard::BiosInvalidError; |
embeddedartists | 22:1a58a518435c | 141 | break; |
embeddedartists | 22:1a58a518435c | 142 | } |
embeddedartists | 22:1a58a518435c | 143 | |
embeddedartists | 22:1a58a518435c | 144 | // Bios header has been verified and seems ok |
embeddedartists | 22:1a58a518435c | 145 | *data = _conf; |
embeddedartists | 22:1a58a518435c | 146 | *size = _confSize; |
embeddedartists | 22:1a58a518435c | 147 | err = DMBoard::Ok; |
embeddedartists | 22:1a58a518435c | 148 | } while (false); |
embeddedartists | 22:1a58a518435c | 149 | |
embeddedartists | 22:1a58a518435c | 150 | if (err != DMBoard::Ok) { |
embeddedartists | 22:1a58a518435c | 151 | if (_conf != NULL) { |
embeddedartists | 22:1a58a518435c | 152 | free(_conf); |
embeddedartists | 22:1a58a518435c | 153 | _conf = NULL; |
embeddedartists | 22:1a58a518435c | 154 | _confSize = 0; |
embeddedartists | 22:1a58a518435c | 155 | } |
embeddedartists | 22:1a58a518435c | 156 | } |
embeddedartists | 22:1a58a518435c | 157 | |
embeddedartists | 22:1a58a518435c | 158 | return err; |
embeddedartists | 22:1a58a518435c | 159 | } |
embeddedartists | 22:1a58a518435c | 160 | |
embeddedartists | 22:1a58a518435c | 161 | DMBoard::BoardError BiosLoader::params(bios_header_t** header, void** instanceData) |
embeddedartists | 22:1a58a518435c | 162 | { |
embeddedartists | 22:1a58a518435c | 163 | if (!_initialized) { |
embeddedartists | 22:1a58a518435c | 164 | DMBoard::BoardError err = init(); |
embeddedartists | 22:1a58a518435c | 165 | if (err != DMBoard::Ok) { |
embeddedartists | 22:1a58a518435c | 166 | return err; |
embeddedartists | 22:1a58a518435c | 167 | } |
embeddedartists | 22:1a58a518435c | 168 | } |
embeddedartists | 22:1a58a518435c | 169 | if (_initialized) { |
embeddedartists | 22:1a58a518435c | 170 | *header = &_bios; |
embeddedartists | 22:1a58a518435c | 171 | *instanceData = _biosData; |
embeddedartists | 22:1a58a518435c | 172 | return DMBoard::Ok; |
embeddedartists | 22:1a58a518435c | 173 | } else { |
embeddedartists | 22:1a58a518435c | 174 | return DMBoard::BiosInvalidError; |
embeddedartists | 22:1a58a518435c | 175 | } |
embeddedartists | 22:1a58a518435c | 176 | } |
embeddedartists | 22:1a58a518435c | 177 | |
embeddedartists | 22:1a58a518435c | 178 | DMBoard::BoardError BiosLoader::init() |
embeddedartists | 22:1a58a518435c | 179 | { |
embeddedartists | 22:1a58a518435c | 180 | DMBoard::BoardError err = DMBoard::Ok; |
embeddedartists | 22:1a58a518435c | 181 | if (!_initialized) { |
embeddedartists | 22:1a58a518435c | 182 | do { |
embeddedartists | 22:1a58a518435c | 183 | |
embeddedartists | 22:1a58a518435c | 184 | // Get the display bios from the DMBoard. DMBoard will have verified it |
embeddedartists | 22:1a58a518435c | 185 | // and will keep it in RAM so there is no need to copy it. |
embeddedartists | 22:1a58a518435c | 186 | uint8_t* p = NULL; |
embeddedartists | 22:1a58a518435c | 187 | uint32_t size = 0; |
embeddedartists | 22:1a58a518435c | 188 | err = readBIOS(&p, &size); |
embeddedartists | 22:1a58a518435c | 189 | if (err != BiosError_Ok) { |
embeddedartists | 22:1a58a518435c | 190 | break; |
embeddedartists | 22:1a58a518435c | 191 | } |
embeddedartists | 22:1a58a518435c | 192 | |
embeddedartists | 22:1a58a518435c | 193 | // Extract the function pointers so that they can be modified to match the |
embeddedartists | 22:1a58a518435c | 194 | // actual location of the code |
embeddedartists | 22:1a58a518435c | 195 | file_header_t* file_header = (file_header_t*)p; |
embeddedartists | 22:1a58a518435c | 196 | memcpy(&_bios, &file_header->header, sizeof(bios_header_t)); |
embeddedartists | 22:1a58a518435c | 197 | |
embeddedartists | 22:1a58a518435c | 198 | // Allocate memory for the BIOS instance data |
embeddedartists | 22:1a58a518435c | 199 | _biosData = malloc(file_header->paramSize); |
embeddedartists | 22:1a58a518435c | 200 | if (_biosData == NULL) { |
embeddedartists | 22:1a58a518435c | 201 | err = DMBoard::MemoryError; |
embeddedartists | 22:1a58a518435c | 202 | break; |
embeddedartists | 22:1a58a518435c | 203 | } |
embeddedartists | 22:1a58a518435c | 204 | |
embeddedartists | 22:1a58a518435c | 205 | // All offsets must be moved by two factors: |
embeddedartists | 22:1a58a518435c | 206 | // 1) The position of the code in RAM (location of "p") |
embeddedartists | 22:1a58a518435c | 207 | // 2) The header size (the code/data comes after it) |
embeddedartists | 22:1a58a518435c | 208 | uint32_t offset = ((uint32_t)p) + file_header->headerSize; |
embeddedartists | 22:1a58a518435c | 209 | uint32_t* functions = (uint32_t*)&_bios; |
embeddedartists | 22:1a58a518435c | 210 | for (int i = 0; i < (sizeof(bios_header_t)/sizeof(uint32_t)); i++) { |
embeddedartists | 22:1a58a518435c | 211 | functions[i] += offset; |
embeddedartists | 22:1a58a518435c | 212 | } |
embeddedartists | 22:1a58a518435c | 213 | |
embeddedartists | 22:1a58a518435c | 214 | #if defined(DM_BOARD_BIOS_DEVELOPMENT) |
embeddedartists | 22:1a58a518435c | 215 | // This requires that the project contains the source code for the BIOS |
embeddedartists | 24:9a677afc86f1 | 216 | const char* msg; |
embeddedartists | 24:9a677afc86f1 | 217 | bios_debug_aid(&_bios, &msg); |
embeddedartists | 24:9a677afc86f1 | 218 | DMBoard::instance().logger()->printf("BIOS info: %s\n", msg); |
embeddedartists | 22:1a58a518435c | 219 | #endif |
embeddedartists | 22:1a58a518435c | 220 | |
embeddedartists | 22:1a58a518435c | 221 | // Prepare the BIOS instance data before calling the first function |
embeddedartists | 22:1a58a518435c | 222 | BiosError_t e = _bios.initParams(_biosData, SystemCoreClock, PeripheralClock, wait_us, readTimeMs); |
embeddedartists | 22:1a58a518435c | 223 | if (e != BiosError_Ok) { |
embeddedartists | 22:1a58a518435c | 224 | err = DMBoard::BiosInvalidError; |
embeddedartists | 22:1a58a518435c | 225 | break; |
embeddedartists | 22:1a58a518435c | 226 | } |
embeddedartists | 22:1a58a518435c | 227 | |
embeddedartists | 22:1a58a518435c | 228 | _initialized = true; |
embeddedartists | 22:1a58a518435c | 229 | } while(0); |
embeddedartists | 22:1a58a518435c | 230 | } |
embeddedartists | 22:1a58a518435c | 231 | return err; |
embeddedartists | 22:1a58a518435c | 232 | } |
embeddedartists | 22:1a58a518435c | 233 | |
embeddedartists | 22:1a58a518435c | 234 | void BiosLoader::resetI2C() |
embeddedartists | 22:1a58a518435c | 235 | { |
embeddedartists | 22:1a58a518435c | 236 | DMBoard::instance().logger()->printf("BiosLoader::resetI2C()\n"); |
embeddedartists | 22:1a58a518435c | 237 | DigitalOut reset(P0_23); |
embeddedartists | 22:1a58a518435c | 238 | reset = 0; |
embeddedartists | 22:1a58a518435c | 239 | wait_ms(1); |
embeddedartists | 22:1a58a518435c | 240 | reset = 1; |
embeddedartists | 22:1a58a518435c | 241 | wait_ms(10); |
embeddedartists | 22:1a58a518435c | 242 | } |
embeddedartists | 22:1a58a518435c | 243 | |
embeddedartists | 22:1a58a518435c | 244 | |
embeddedartists | 22:1a58a518435c | 245 | /****************************************************************************** |
embeddedartists | 22:1a58a518435c | 246 | * Public Functions |
embeddedartists | 22:1a58a518435c | 247 | *****************************************************************************/ |
embeddedartists | 22:1a58a518435c | 248 | |
embeddedartists | 22:1a58a518435c | 249 | bool BiosLoader::isKnownSPIFIMemory(uint8_t mfgr, uint8_t devType, uint8_t devID, uint32_t memSize, uint32_t* eraseBlockSize) |
embeddedartists | 22:1a58a518435c | 250 | { |
embeddedartists | 22:1a58a518435c | 251 | if (!_initialized) { |
embeddedartists | 22:1a58a518435c | 252 | DMBoard::BoardError err = init(); |
embeddedartists | 22:1a58a518435c | 253 | if (err != DMBoard::Ok) { |
embeddedartists | 22:1a58a518435c | 254 | return false; |
embeddedartists | 22:1a58a518435c | 255 | } |
embeddedartists | 22:1a58a518435c | 256 | } |
embeddedartists | 22:1a58a518435c | 257 | if (_initialized) { |
embeddedartists | 22:1a58a518435c | 258 | bool known = false; |
embeddedartists | 22:1a58a518435c | 259 | BiosError_t err = _bios.spifiIsSupported(_biosData, mfgr,devType,devID,memSize,&known,eraseBlockSize); |
embeddedartists | 22:1a58a518435c | 260 | if (err == BiosError_Ok) { |
embeddedartists | 22:1a58a518435c | 261 | return known; |
embeddedartists | 22:1a58a518435c | 262 | } |
embeddedartists | 22:1a58a518435c | 263 | } |
embeddedartists | 22:1a58a518435c | 264 | return false; |
embeddedartists | 22:1a58a518435c | 265 | } |