pmem-region.txt 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. Device-tree bindings for persistent memory regions
  2. -----------------------------------------------------
  3. Persistent memory refers to a class of memory devices that are:
  4. a) Usable as main system memory (i.e. cacheable), and
  5. b) Retain their contents across power failure.
  6. Given b) it is best to think of persistent memory as a kind of memory mapped
  7. storage device. To ensure data integrity the operating system needs to manage
  8. persistent regions separately to the normal memory pool. To aid with that this
  9. binding provides a standardised interface for discovering where persistent
  10. memory regions exist inside the physical address space.
  11. Bindings for the region nodes:
  12. -----------------------------
  13. Required properties:
  14. - compatible = "pmem-region"
  15. - reg = <base, size>;
  16. The reg property should specificy an address range that is
  17. translatable to a system physical address range. This address
  18. range should be mappable as normal system memory would be
  19. (i.e cacheable).
  20. If the reg property contains multiple address ranges
  21. each address range will be treated as though it was specified
  22. in a separate device node. Having multiple address ranges in a
  23. node implies no special relationship between the two ranges.
  24. Optional properties:
  25. - Any relevant NUMA assocativity properties for the target platform.
  26. - volatile; This property indicates that this region is actually
  27. backed by non-persistent memory. This lets the OS know that it
  28. may skip the cache flushes required to ensure data is made
  29. persistent after a write.
  30. If this property is absent then the OS must assume that the region
  31. is backed by non-volatile memory.
  32. Examples:
  33. --------------------
  34. /*
  35. * This node specifies one 4KB region spanning from
  36. * 0x5000 to 0x5fff that is backed by non-volatile memory.
  37. */
  38. pmem@5000 {
  39. compatible = "pmem-region";
  40. reg = <0x00005000 0x00001000>;
  41. };
  42. /*
  43. * This node specifies two 4KB regions that are backed by
  44. * volatile (normal) memory.
  45. */
  46. pmem@6000 {
  47. compatible = "pmem-region";
  48. reg = < 0x00006000 0x00001000
  49. 0x00008000 0x00001000 >;
  50. volatile;
  51. };