/* ChibiOS/RT - Copyright (C) 2006-2007 Giovanni Di Sirio. This file is part of ChibiOS/RT. ChibiOS/RT is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. ChibiOS/RT is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . */ /** * @page article_portguide Porting ChibiOS/RT for Dummies * Porting the operating system on a new platform is one of the most common * tasks. The difficulty can range from easy to very difficult depending * on several factors.
* We can divide in problem in several classes of progressively increasing * difficulty: * - @ref port_board * - @ref port_family * - @ref port_chip * - @ref port_core * . * Another kind of port type is porting to another compiler and this is an * added complexity level on the above classes. The kernel itself is portable * but the port-specific code usually contains compiler specific extensions to * the C language and the asm files syntax is almost never compatible. * * @section port_board Porting the OS to a new board * This is the easiest port type, the scenario is that the specific * microcontroller is already supported and a demo exists. This scenario also * applies when porting the OS on a custom hardware using a supported * microcontroller. This task can be easily performed with the following * steps: * -# Create a new directory under the ChibiOS/RT installation directory: * ./projects/@ * -# Copy the microcontroller demo code under the newly created directory. * -# Customize the demo. Usually there are only four files that need to * be modified: * - @p board.h This file contains the I/O pins setup for the uC, it * may also contain other board-dependent settings, as example, clock and * PLL settings. Customize this file depending on your target hardware. * - @p board.c This file contains the initialization code, it is possible * you just need to customize @p board.h and not this file. If you have * some hardware specific initialization code then put it here. * - @p Makefile You may edit this file in order to remove the test related * sources and/or add you application source files. * - @p main.c It contains the demo simple code, clean it and write your * own @p main() function here, use this file just as a template. * -# Compile your application and debug. * . * @section port_family Porting the OS to a closely related microcontroller * In this scenario all the above steps are required but an analysis must * be performed to evaluate the differences between from the supported micro * and the target micro. Often the micros just differ for the memory area * sizes and a change to the linker script is enough (the file is usually * named @p ch.ld). Chips having more or less peripherals, everything else * being the same or compatible are not a problem also as long the timer and * the serial peripherals used by the port do not change.
* If there are differences in the internal peripherals, as example non * compatible interrupt controllers (this happens in the LPC2000 family) * or differences in UARTS, timers etc then the port falls in the following * category. * * @section port_chip Porting the OS to another microcontroller using the same core * This kind of port is required when a target microcontroller has the same * core (a common example: ARM7) of a supported microcontroller but has * differences in the internal peripherals.
* If this is your case proceed as follow: * -# Create a new directory under @p ./os/io/platforms and * name it with the microcontroller name (or family name).
* In case of the ARM-based microcontroller you also need to create a * equally named directory under * @p ./os/ports/@/@ and * put there the microcontroller related files such as the vectors table, * see the existing ports as example. * -# Copy into the newly created directory the most closely related existing * chip port or the naked template files from * @p ./os/io/templates. * -# Work out the differences in the drivers or implement them if you started * from the templates. * -# Edit/create the documentation file @p platform.dox, this * is required if you want to regenerate this documentation including * your work. * . * Usually this kind of port just requires a serial driver (and those are very * similar each other) and some code for the interrupt controller (this one * can be part of the core port, as example the Cortex-M3 has this as standard * part of the core).
* When the chip port is completed created your application as seen in the * previous sections. * * @section port_core Porting the OS to a whole new architecture * This is the hardest scenario, the time required by core ports depends * strongly by the target architecture complexity and the level of support you * need for the architecture specific features.
* As a reference, the MSP430 port took me 2 hours and it worked at the first * run, it can be a reference for simple architectures, the ARM Cortex-M3 was * painful instead, the architecture enforces you to implement things in a very * specific way and I spent 2 week to go through all the documentation and * figure out the correct way to implement the port (you can see that the * preemption context switch is done in a very peculiar way because the * exceptions architecture).
* One thing is sure, port an OS to a new architecture is not an easy task and * if you have the required experience for such an effort then probably you * don't need any advice from me. Just follow the directory patterns and fill * the OS template files, the hardest part is decide the correct and efficient * way to implement the context switching. */ 05' href='#n105'>105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564

# Defining a Mock Class #

## Mocking a Normal Class ##

Given
```
class Foo {
  ...
  virtual ~Foo();
  virtual int GetSize() const = 0;
  virtual string Describe(const char* name) = 0;
  virtual string Describe(int type) = 0;
  virtual bool Process(Bar elem, int count) = 0;
};
```
(note that `~Foo()` **must** be virtual) we can define its mock as
```
#include "gmock/gmock.h"

class MockFoo : public Foo {
  MOCK_CONST_METHOD0(GetSize, int());
  MOCK_METHOD1(Describe, string(const char* name));
  MOCK_METHOD1(Describe, string(int type));
  MOCK_METHOD2(Process, bool(Bar elem, int count));
};
```

To create a "nice" mock object which ignores all uninteresting calls,
or a "strict" mock object, which treats them as failures:
```
NiceMock<MockFoo> nice_foo;     // The type is a subclass of MockFoo.
StrictMock<MockFoo> strict_foo; // The type is a subclass of MockFoo.
```

## Mocking a Class Template ##

To mock
```
template <typename Elem>
class StackInterface {
 public:
  ...
  virtual ~StackInterface();
  virtual int GetSize() const = 0;
  virtual void Push(const Elem& x) = 0;
};
```
(note that `~StackInterface()` **must** be virtual) just append `_T` to the `MOCK_*` macros:
```
template <typename Elem>
class MockStack : public StackInterface<Elem> {
 public:
  ...
  MOCK_CONST_METHOD0_T(GetSize, int());
  MOCK_METHOD1_T(Push, void(const Elem& x));
};
```

## Specifying Calling Conventions for Mock Functions ##

If your mock function doesn't use the default calling convention, you
can specify it by appending `_WITH_CALLTYPE` to any of the macros
described in the previous two sections and supplying the calling
convention as the first argument to the macro. For example,
```
  MOCK_METHOD1_WITH_CALLTYPE(STDMETHODCALLTYPE, Foo, bool(int n));
  MOCK_CONST_METHOD2_WITH_CALLTYPE(STDMETHODCALLTYPE, Bar, int(double x, double y));