SdFatUtil.h 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. /* Arduino SdFat Library
  2. * Copyright (C) 2008 by William Greiman
  3. *
  4. * This file is part of the Arduino SdFat Library
  5. *
  6. * This Library is free software: you can redistribute it and/or modify
  7. * it under the terms of the GNU General Public License as published by
  8. * the Free Software Foundation, either version 3 of the License, or
  9. * (at your option) any later version.
  10. *
  11. * This Library is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. * You should have received a copy of the GNU General Public License
  16. * along with the Arduino SdFat Library. If not, see
  17. * <http://www.gnu.org/licenses/>.
  18. */
  19. #ifndef SdFatUtil_h
  20. #define SdFatUtil_h
  21. /**
  22. * \file
  23. * Useful utility functions.
  24. */
  25. #include <WProgram.h>
  26. #include <avr/pgmspace.h>
  27. /** Store and print a string in flash memory.*/
  28. #define PgmPrint(x) SerialPrint_P(PSTR(x))
  29. /** Store and print a string in flash memory followed by a CR/LF.*/
  30. #define PgmPrintln(x) SerialPrintln_P(PSTR(x))
  31. /** Defined so doxygen works for function definitions. */
  32. #define NOINLINE __attribute__((noinline))
  33. //------------------------------------------------------------------------------
  34. /** Return the number of bytes currently free in RAM. */
  35. static int FreeRam(void) {
  36. extern int __bss_end;
  37. extern int* __brkval;
  38. int free_memory;
  39. if (reinterpret_cast<int>(__brkval) == 0) {
  40. // if no heap use from end of bss section
  41. free_memory = reinterpret_cast<int>(&free_memory)
  42. - reinterpret_cast<int>(&__bss_end);
  43. } else {
  44. // use from top of stack to heap
  45. free_memory = reinterpret_cast<int>(&free_memory)
  46. - reinterpret_cast<int>(__brkval);
  47. }
  48. return free_memory;
  49. }
  50. //------------------------------------------------------------------------------
  51. /**
  52. * %Print a string in flash memory to the serial port.
  53. *
  54. * \param[in] str Pointer to string stored in flash memory.
  55. */
  56. static NOINLINE void SerialPrint_P(PGM_P str) {
  57. for (uint8_t c; (c = pgm_read_byte(str)); str++) Serial.print(char(c));
  58. }
  59. //------------------------------------------------------------------------------
  60. /**
  61. * %Print a string in flash memory followed by a CR/LF.
  62. *
  63. * \param[in] str Pointer to string stored in flash memory.
  64. */
  65. static NOINLINE void SerialPrintln_P(PGM_P str) {
  66. SerialPrint_P(str);
  67. Serial.println();
  68. }
  69. #endif // #define SdFatUtil_h