xip.h 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. /*
  2. * MTD primitives for XIP support
  3. *
  4. * Author: Nicolas Pitre
  5. * Created: Nov 2, 2004
  6. * Copyright: (C) 2004 MontaVista Software, Inc.
  7. *
  8. * This XIP support for MTD has been loosely inspired
  9. * by an earlier patch authored by David Woodhouse.
  10. *
  11. * This program is free software; you can redistribute it and/or modify
  12. * it under the terms of the GNU General Public License version 2 as
  13. * published by the Free Software Foundation.
  14. */
  15. #ifndef __LINUX_MTD_XIP_H__
  16. #define __LINUX_MTD_XIP_H__
  17. #ifdef CONFIG_MTD_XIP
  18. /*
  19. * We really don't want gcc to guess anything.
  20. * We absolutely _need_ proper inlining.
  21. */
  22. #include <linux/compiler.h>
  23. /*
  24. * Function that are modifying the flash state away from array mode must
  25. * obviously not be running from flash. The __xipram is therefore marking
  26. * those functions so they get relocated to ram.
  27. */
  28. #define __xipram noinline __attribute__ ((__section__ (".data")))
  29. /*
  30. * Each architecture has to provide the following macros. They must access
  31. * the hardware directly and not rely on any other (XIP) functions since they
  32. * won't be available when used (flash not in array mode).
  33. *
  34. * xip_irqpending()
  35. *
  36. * return non zero when any hardware interrupt is pending.
  37. *
  38. * xip_currtime()
  39. *
  40. * return a platform specific time reference to be used with
  41. * xip_elapsed_since().
  42. *
  43. * xip_elapsed_since(x)
  44. *
  45. * return in usecs the elapsed timebetween now and the reference x as
  46. * returned by xip_currtime().
  47. *
  48. * note 1: conversion to usec can be approximated, as long as the
  49. * returned value is <= the real elapsed time.
  50. * note 2: this should be able to cope with a few seconds without
  51. * overflowing.
  52. *
  53. * xip_iprefetch()
  54. *
  55. * Macro to fill instruction prefetch
  56. * e.g. a series of nops: asm volatile (".rep 8; nop; .endr");
  57. */
  58. #include <asm/mtd-xip.h>
  59. #ifndef xip_irqpending
  60. #warning "missing IRQ and timer primitives for XIP MTD support"
  61. #warning "some of the XIP MTD support code will be disabled"
  62. #warning "your system will therefore be unresponsive when writing or erasing flash"
  63. #define xip_irqpending() (0)
  64. #define xip_currtime() (0)
  65. #define xip_elapsed_since(x) (0)
  66. #endif
  67. #ifndef xip_iprefetch
  68. #define xip_iprefetch() do { } while (0)
  69. #endif
  70. /*
  71. * xip_cpu_idle() is used when waiting for a delay equal or larger than
  72. * the system timer tick period. This should put the CPU into idle mode
  73. * to save power and to be woken up only when some interrupts are pending.
  74. * This should not rely upon standard kernel code.
  75. */
  76. #ifndef xip_cpu_idle
  77. #define xip_cpu_idle() do { } while (0)
  78. #endif
  79. #else
  80. #define __xipram
  81. #endif /* CONFIG_MTD_XIP */
  82. #endif /* __LINUX_MTD_XIP_H__ */