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@26:a65fbb4bde5c, 2015-01-22 (annotated)
- Committer:
- embeddedartists
- Date:
- Thu Jan 22 16:04:54 2015 +0100
- Revision:
- 26:a65fbb4bde5c
- Parent:
- 24:9a677afc86f1
- Child:
- 27:0499c29688cc
- Changed BIOS version info to BOARD_ID.MAJ.MIN.REV
- Added support for interrupt drive I2C for the BIOS
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 | 26:a65fbb4bde5c | 28 | void bios_debug_aid(bios_header_t* header, const char** pMsg, uint32_t* paramSize); |
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 | 26:a65fbb4bde5c | 51 | /* |
embeddedartists | 26:a65fbb4bde5c | 52 | * The BIOS is API compatible as long as the Major component of the |
embeddedartists | 26:a65fbb4bde5c | 53 | * version is the same. |
embeddedartists | 26:a65fbb4bde5c | 54 | */ |
embeddedartists | 26:a65fbb4bde5c | 55 | #define SUPPORTED_BIOS_VER 0x000000 |
embeddedartists | 26:a65fbb4bde5c | 56 | #define SUPPORTED_BIOS_MASK 0xff0000 // only look at the Major component |
embeddedartists | 26:a65fbb4bde5c | 57 | #define SUPPORTED_VERSION(__ver) (((__ver)&SUPPORTED_BIOS_MASK) == SUPPORTED_BIOS_VER) |
embeddedartists | 26:a65fbb4bde5c | 58 | |
embeddedartists | 22:1a58a518435c | 59 | /****************************************************************************** |
embeddedartists | 22:1a58a518435c | 60 | * Local variables |
embeddedartists | 22:1a58a518435c | 61 | *****************************************************************************/ |
embeddedartists | 22:1a58a518435c | 62 | |
embeddedartists | 22:1a58a518435c | 63 | |
embeddedartists | 22:1a58a518435c | 64 | /****************************************************************************** |
embeddedartists | 22:1a58a518435c | 65 | * Private Functions |
embeddedartists | 22:1a58a518435c | 66 | *****************************************************************************/ |
embeddedartists | 22:1a58a518435c | 67 | |
embeddedartists | 22:1a58a518435c | 68 | // Function called from the BIOS |
embeddedartists | 22:1a58a518435c | 69 | static uint32_t readTimeMs() |
embeddedartists | 22:1a58a518435c | 70 | { |
embeddedartists | 22:1a58a518435c | 71 | return us_ticker_read()/1000; |
embeddedartists | 22:1a58a518435c | 72 | } |
embeddedartists | 22:1a58a518435c | 73 | |
embeddedartists | 22:1a58a518435c | 74 | |
embeddedartists | 22:1a58a518435c | 75 | BiosLoader::BiosLoader() : |
embeddedartists | 22:1a58a518435c | 76 | _initialized(false), |
embeddedartists | 22:1a58a518435c | 77 | _biosData(NULL), |
embeddedartists | 22:1a58a518435c | 78 | _conf(NULL), |
embeddedartists | 22:1a58a518435c | 79 | _confSize(0) |
embeddedartists | 22:1a58a518435c | 80 | { |
embeddedartists | 22:1a58a518435c | 81 | } |
embeddedartists | 22:1a58a518435c | 82 | |
embeddedartists | 22:1a58a518435c | 83 | BiosLoader::~BiosLoader() |
embeddedartists | 22:1a58a518435c | 84 | { |
embeddedartists | 22:1a58a518435c | 85 | if (_biosData != NULL) { |
embeddedartists | 22:1a58a518435c | 86 | free(_biosData); |
embeddedartists | 22:1a58a518435c | 87 | _biosData = NULL; |
embeddedartists | 22:1a58a518435c | 88 | } |
embeddedartists | 22:1a58a518435c | 89 | if (_conf != NULL) { |
embeddedartists | 22:1a58a518435c | 90 | free(_conf); |
embeddedartists | 22:1a58a518435c | 91 | _conf = NULL; |
embeddedartists | 22:1a58a518435c | 92 | _confSize = 0; |
embeddedartists | 22:1a58a518435c | 93 | } |
embeddedartists | 22:1a58a518435c | 94 | } |
embeddedartists | 22:1a58a518435c | 95 | |
embeddedartists | 22:1a58a518435c | 96 | DMBoard::BoardError BiosLoader::readBIOS(uint8_t** data, uint32_t* size) |
embeddedartists | 22:1a58a518435c | 97 | { |
embeddedartists | 22:1a58a518435c | 98 | DMBoard::BoardError err = DMBoard::Ok; |
embeddedartists | 22:1a58a518435c | 99 | BiosEEPROM eeprom; |
embeddedartists | 22:1a58a518435c | 100 | file_header_t fh; |
embeddedartists | 22:1a58a518435c | 101 | |
embeddedartists | 22:1a58a518435c | 102 | if (_conf != NULL) { |
embeddedartists | 22:1a58a518435c | 103 | *data = _conf; |
embeddedartists | 22:1a58a518435c | 104 | *size = _confSize; |
embeddedartists | 22:1a58a518435c | 105 | return DMBoard::Ok; |
embeddedartists | 22:1a58a518435c | 106 | } |
embeddedartists | 22:1a58a518435c | 107 | |
embeddedartists | 22:1a58a518435c | 108 | do { |
embeddedartists | 22:1a58a518435c | 109 | if (!eeprom.read(0, (char*)&fh, sizeof(file_header_t))) { |
embeddedartists | 22:1a58a518435c | 110 | resetI2C(); |
embeddedartists | 22:1a58a518435c | 111 | if (!eeprom.read(0, (char*)&fh, sizeof(file_header_t))) { |
embeddedartists | 22:1a58a518435c | 112 | err = DMBoard::BiosStorageError; |
embeddedartists | 22:1a58a518435c | 113 | break; |
embeddedartists | 22:1a58a518435c | 114 | } |
embeddedartists | 22:1a58a518435c | 115 | } |
embeddedartists | 22:1a58a518435c | 116 | |
embeddedartists | 22:1a58a518435c | 117 | if (fh.magic != BIOS_MAGIC) { |
embeddedartists | 22:1a58a518435c | 118 | err = DMBoard::BiosInvalidError; |
embeddedartists | 22:1a58a518435c | 119 | break; |
embeddedartists | 22:1a58a518435c | 120 | } |
embeddedartists | 22:1a58a518435c | 121 | |
embeddedartists | 26:a65fbb4bde5c | 122 | if (!SUPPORTED_VERSION(fh.version)) { |
embeddedartists | 22:1a58a518435c | 123 | err = DMBoard::BiosVersionError; |
embeddedartists | 22:1a58a518435c | 124 | break; |
embeddedartists | 22:1a58a518435c | 125 | } |
embeddedartists | 22:1a58a518435c | 126 | |
embeddedartists | 22:1a58a518435c | 127 | if ((fh.headerSize + fh.size) > BIOS_MAX_SIZE) { |
embeddedartists | 22:1a58a518435c | 128 | err = DMBoard::BiosInvalidError; |
embeddedartists | 22:1a58a518435c | 129 | break; |
embeddedartists | 22:1a58a518435c | 130 | } |
embeddedartists | 22:1a58a518435c | 131 | |
embeddedartists | 22:1a58a518435c | 132 | _confSize = fh.headerSize + fh.size; |
embeddedartists | 22:1a58a518435c | 133 | _conf = (uint8_t*)malloc(MAX(_confSize,BIOS_RESERVED_CHUNK)); |
embeddedartists | 22:1a58a518435c | 134 | if (_conf == NULL) { |
embeddedartists | 22:1a58a518435c | 135 | _confSize = 0; |
embeddedartists | 22:1a58a518435c | 136 | err = DMBoard::MemoryError; |
embeddedartists | 22:1a58a518435c | 137 | break; |
embeddedartists | 22:1a58a518435c | 138 | } |
embeddedartists | 22:1a58a518435c | 139 | |
embeddedartists | 22:1a58a518435c | 140 | if (!eeprom.read(0, (char*)_conf, _confSize)) { |
embeddedartists | 22:1a58a518435c | 141 | err = DMBoard::BiosStorageError; |
embeddedartists | 22:1a58a518435c | 142 | break; |
embeddedartists | 22:1a58a518435c | 143 | } |
embeddedartists | 22:1a58a518435c | 144 | |
embeddedartists | 22:1a58a518435c | 145 | uint32_t crc = crc_Buffer((uint32_t*)(&_conf[fh.headerSize]), fh.size/4); |
embeddedartists | 22:1a58a518435c | 146 | if (crc != fh.crc) { |
embeddedartists | 22:1a58a518435c | 147 | err = DMBoard::BiosInvalidError; |
embeddedartists | 22:1a58a518435c | 148 | break; |
embeddedartists | 22:1a58a518435c | 149 | } |
embeddedartists | 22:1a58a518435c | 150 | |
embeddedartists | 22:1a58a518435c | 151 | // Bios header has been verified and seems ok |
embeddedartists | 22:1a58a518435c | 152 | *data = _conf; |
embeddedartists | 22:1a58a518435c | 153 | *size = _confSize; |
embeddedartists | 22:1a58a518435c | 154 | err = DMBoard::Ok; |
embeddedartists | 22:1a58a518435c | 155 | } while (false); |
embeddedartists | 22:1a58a518435c | 156 | |
embeddedartists | 22:1a58a518435c | 157 | if (err != DMBoard::Ok) { |
embeddedartists | 22:1a58a518435c | 158 | if (_conf != NULL) { |
embeddedartists | 22:1a58a518435c | 159 | free(_conf); |
embeddedartists | 22:1a58a518435c | 160 | _conf = NULL; |
embeddedartists | 22:1a58a518435c | 161 | _confSize = 0; |
embeddedartists | 22:1a58a518435c | 162 | } |
embeddedartists | 22:1a58a518435c | 163 | } |
embeddedartists | 22:1a58a518435c | 164 | |
embeddedartists | 22:1a58a518435c | 165 | return err; |
embeddedartists | 22:1a58a518435c | 166 | } |
embeddedartists | 22:1a58a518435c | 167 | |
embeddedartists | 22:1a58a518435c | 168 | DMBoard::BoardError BiosLoader::params(bios_header_t** header, void** instanceData) |
embeddedartists | 22:1a58a518435c | 169 | { |
embeddedartists | 22:1a58a518435c | 170 | if (!_initialized) { |
embeddedartists | 22:1a58a518435c | 171 | DMBoard::BoardError err = init(); |
embeddedartists | 22:1a58a518435c | 172 | if (err != DMBoard::Ok) { |
embeddedartists | 22:1a58a518435c | 173 | return err; |
embeddedartists | 22:1a58a518435c | 174 | } |
embeddedartists | 22:1a58a518435c | 175 | } |
embeddedartists | 22:1a58a518435c | 176 | if (_initialized) { |
embeddedartists | 22:1a58a518435c | 177 | *header = &_bios; |
embeddedartists | 22:1a58a518435c | 178 | *instanceData = _biosData; |
embeddedartists | 22:1a58a518435c | 179 | return DMBoard::Ok; |
embeddedartists | 22:1a58a518435c | 180 | } else { |
embeddedartists | 22:1a58a518435c | 181 | return DMBoard::BiosInvalidError; |
embeddedartists | 22:1a58a518435c | 182 | } |
embeddedartists | 22:1a58a518435c | 183 | } |
embeddedartists | 22:1a58a518435c | 184 | |
embeddedartists | 22:1a58a518435c | 185 | DMBoard::BoardError BiosLoader::init() |
embeddedartists | 22:1a58a518435c | 186 | { |
embeddedartists | 22:1a58a518435c | 187 | DMBoard::BoardError err = DMBoard::Ok; |
embeddedartists | 22:1a58a518435c | 188 | if (!_initialized) { |
embeddedartists | 22:1a58a518435c | 189 | do { |
embeddedartists | 22:1a58a518435c | 190 | |
embeddedartists | 22:1a58a518435c | 191 | // Get the display bios from the DMBoard. DMBoard will have verified it |
embeddedartists | 22:1a58a518435c | 192 | // and will keep it in RAM so there is no need to copy it. |
embeddedartists | 22:1a58a518435c | 193 | uint8_t* p = NULL; |
embeddedartists | 22:1a58a518435c | 194 | uint32_t size = 0; |
embeddedartists | 22:1a58a518435c | 195 | err = readBIOS(&p, &size); |
embeddedartists | 22:1a58a518435c | 196 | if (err != BiosError_Ok) { |
embeddedartists | 22:1a58a518435c | 197 | break; |
embeddedartists | 22:1a58a518435c | 198 | } |
embeddedartists | 22:1a58a518435c | 199 | |
embeddedartists | 22:1a58a518435c | 200 | // Extract the function pointers so that they can be modified to match the |
embeddedartists | 22:1a58a518435c | 201 | // actual location of the code |
embeddedartists | 22:1a58a518435c | 202 | file_header_t* file_header = (file_header_t*)p; |
embeddedartists | 22:1a58a518435c | 203 | memcpy(&_bios, &file_header->header, sizeof(bios_header_t)); |
embeddedartists | 22:1a58a518435c | 204 | |
embeddedartists | 22:1a58a518435c | 205 | // Allocate memory for the BIOS instance data |
embeddedartists | 22:1a58a518435c | 206 | _biosData = malloc(file_header->paramSize); |
embeddedartists | 22:1a58a518435c | 207 | if (_biosData == NULL) { |
embeddedartists | 22:1a58a518435c | 208 | err = DMBoard::MemoryError; |
embeddedartists | 22:1a58a518435c | 209 | break; |
embeddedartists | 22:1a58a518435c | 210 | } |
embeddedartists | 22:1a58a518435c | 211 | |
embeddedartists | 22:1a58a518435c | 212 | // All offsets must be moved by two factors: |
embeddedartists | 22:1a58a518435c | 213 | // 1) The position of the code in RAM (location of "p") |
embeddedartists | 22:1a58a518435c | 214 | // 2) The header size (the code/data comes after it) |
embeddedartists | 22:1a58a518435c | 215 | uint32_t offset = ((uint32_t)p) + file_header->headerSize; |
embeddedartists | 22:1a58a518435c | 216 | uint32_t* functions = (uint32_t*)&_bios; |
embeddedartists | 22:1a58a518435c | 217 | for (int i = 0; i < (sizeof(bios_header_t)/sizeof(uint32_t)); i++) { |
embeddedartists | 22:1a58a518435c | 218 | functions[i] += offset; |
embeddedartists | 22:1a58a518435c | 219 | } |
embeddedartists | 22:1a58a518435c | 220 | |
embeddedartists | 22:1a58a518435c | 221 | #if defined(DM_BOARD_BIOS_DEVELOPMENT) |
embeddedartists | 22:1a58a518435c | 222 | // This requires that the project contains the source code for the BIOS |
embeddedartists | 24:9a677afc86f1 | 223 | const char* msg; |
embeddedartists | 26:a65fbb4bde5c | 224 | uint32_t tmp = 0; |
embeddedartists | 26:a65fbb4bde5c | 225 | bios_debug_aid(&_bios, &msg, &tmp); |
embeddedartists | 26:a65fbb4bde5c | 226 | if (tmp > file_header->paramSize) { |
embeddedartists | 26:a65fbb4bde5c | 227 | free(_biosData); |
embeddedartists | 26:a65fbb4bde5c | 228 | _biosData = malloc(tmp); |
embeddedartists | 26:a65fbb4bde5c | 229 | if (_biosData == NULL) { |
embeddedartists | 26:a65fbb4bde5c | 230 | err = DMBoard::MemoryError; |
embeddedartists | 26:a65fbb4bde5c | 231 | break; |
embeddedartists | 26:a65fbb4bde5c | 232 | } |
embeddedartists | 26:a65fbb4bde5c | 233 | } |
embeddedartists | 24:9a677afc86f1 | 234 | DMBoard::instance().logger()->printf("BIOS info: %s\n", msg); |
embeddedartists | 22:1a58a518435c | 235 | #endif |
embeddedartists | 22:1a58a518435c | 236 | |
embeddedartists | 22:1a58a518435c | 237 | // Prepare the BIOS instance data before calling the first function |
embeddedartists | 22:1a58a518435c | 238 | BiosError_t e = _bios.initParams(_biosData, SystemCoreClock, PeripheralClock, wait_us, readTimeMs); |
embeddedartists | 22:1a58a518435c | 239 | if (e != BiosError_Ok) { |
embeddedartists | 22:1a58a518435c | 240 | err = DMBoard::BiosInvalidError; |
embeddedartists | 22:1a58a518435c | 241 | break; |
embeddedartists | 22:1a58a518435c | 242 | } |
embeddedartists | 22:1a58a518435c | 243 | |
embeddedartists | 22:1a58a518435c | 244 | _initialized = true; |
embeddedartists | 22:1a58a518435c | 245 | } while(0); |
embeddedartists | 22:1a58a518435c | 246 | } |
embeddedartists | 22:1a58a518435c | 247 | return err; |
embeddedartists | 22:1a58a518435c | 248 | } |
embeddedartists | 22:1a58a518435c | 249 | |
embeddedartists | 22:1a58a518435c | 250 | void BiosLoader::resetI2C() |
embeddedartists | 22:1a58a518435c | 251 | { |
embeddedartists | 22:1a58a518435c | 252 | DMBoard::instance().logger()->printf("BiosLoader::resetI2C()\n"); |
embeddedartists | 22:1a58a518435c | 253 | DigitalOut reset(P0_23); |
embeddedartists | 22:1a58a518435c | 254 | reset = 0; |
embeddedartists | 22:1a58a518435c | 255 | wait_ms(1); |
embeddedartists | 22:1a58a518435c | 256 | reset = 1; |
embeddedartists | 22:1a58a518435c | 257 | wait_ms(10); |
embeddedartists | 22:1a58a518435c | 258 | } |
embeddedartists | 22:1a58a518435c | 259 | |
embeddedartists | 22:1a58a518435c | 260 | |
embeddedartists | 22:1a58a518435c | 261 | /****************************************************************************** |
embeddedartists | 22:1a58a518435c | 262 | * Public Functions |
embeddedartists | 22:1a58a518435c | 263 | *****************************************************************************/ |
embeddedartists | 22:1a58a518435c | 264 | |
embeddedartists | 22:1a58a518435c | 265 | bool BiosLoader::isKnownSPIFIMemory(uint8_t mfgr, uint8_t devType, uint8_t devID, uint32_t memSize, uint32_t* eraseBlockSize) |
embeddedartists | 22:1a58a518435c | 266 | { |
embeddedartists | 22:1a58a518435c | 267 | if (!_initialized) { |
embeddedartists | 22:1a58a518435c | 268 | DMBoard::BoardError err = init(); |
embeddedartists | 22:1a58a518435c | 269 | if (err != DMBoard::Ok) { |
embeddedartists | 22:1a58a518435c | 270 | return false; |
embeddedartists | 22:1a58a518435c | 271 | } |
embeddedartists | 22:1a58a518435c | 272 | } |
embeddedartists | 22:1a58a518435c | 273 | if (_initialized) { |
embeddedartists | 22:1a58a518435c | 274 | bool known = false; |
embeddedartists | 22:1a58a518435c | 275 | BiosError_t err = _bios.spifiIsSupported(_biosData, mfgr,devType,devID,memSize,&known,eraseBlockSize); |
embeddedartists | 22:1a58a518435c | 276 | if (err == BiosError_Ok) { |
embeddedartists | 22:1a58a518435c | 277 | return known; |
embeddedartists | 22:1a58a518435c | 278 | } |
embeddedartists | 22:1a58a518435c | 279 | } |
embeddedartists | 22:1a58a518435c | 280 | return false; |
embeddedartists | 22:1a58a518435c | 281 | } |