omap_remoteproc.h 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. /*
  2. * Remote processor messaging
  3. *
  4. * Copyright (C) 2011-2016 Texas Instruments, Inc.
  5. * Copyright (C) 2011 Google, Inc.
  6. * All rights reserved.
  7. *
  8. * Redistribution and use in source and binary forms, with or without
  9. * modification, are permitted provided that the following conditions
  10. * are met:
  11. *
  12. * * Redistributions of source code must retain the above copyright
  13. * notice, this list of conditions and the following disclaimer.
  14. * * Redistributions in binary form must reproduce the above copyright
  15. * notice, this list of conditions and the following disclaimer in
  16. * the documentation and/or other materials provided with the
  17. * distribution.
  18. * * Neither the name Texas Instruments nor the names of its
  19. * contributors may be used to endorse or promote products derived
  20. * from this software without specific prior written permission.
  21. *
  22. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25. * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26. * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28. * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29. * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30. * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33. */
  34. #ifndef _OMAP_RPMSG_H
  35. #define _OMAP_RPMSG_H
  36. /*
  37. * enum - Predefined Mailbox Messages
  38. *
  39. * @RP_MBOX_READY: informs the M3's that we're up and running. this is
  40. * part of the init sequence sent that the M3 expects to see immediately
  41. * after it is booted.
  42. *
  43. * @RP_MBOX_PENDING_MSG: informs the receiver that there is an inbound
  44. * message waiting in its own receive-side vring. please note that currently
  45. * this message is optional: alternatively, one can explicitly send the index
  46. * of the triggered virtqueue itself. the preferred approach will be decided
  47. * as we progress and experiment with those two different approaches.
  48. *
  49. * @RP_MBOX_CRASH: this message is sent if BIOS crashes
  50. *
  51. * @RP_MBOX_ECHO_REQUEST: a mailbox-level "ping" message.
  52. *
  53. * @RP_MBOX_ECHO_REPLY: a mailbox-level reply to a "ping"
  54. *
  55. * @RP_MBOX_ABORT_REQUEST: a "please crash" request, used for testing the
  56. * recovery mechanism (to some extent).
  57. *
  58. * @RP_MBOX_SUSPEND_AUTO: auto suspend request for the remote processor
  59. *
  60. * @RP_MBOX_SUSPEND_SYSTEM: system suspend request for the remote processor
  61. *
  62. * @RP_MBOX_SUSPEND_ACK: successful response from remote processor for a
  63. * suspend request
  64. *
  65. * @RP_MBOX_SUSPEND_CANCEL: a cancel suspend response from a remote processor
  66. * on a suspend request
  67. *
  68. * Introduce new message definitions if any here.
  69. *
  70. * @RP_MBOX_END_MSG: Indicates end of known/defined messages from remote core
  71. * This should be the last definition.
  72. *
  73. */
  74. enum omap_rp_mbox_messages {
  75. RP_MBOX_READY = 0xFFFFFF00,
  76. RP_MBOX_PENDING_MSG = 0xFFFFFF01,
  77. RP_MBOX_CRASH = 0xFFFFFF02,
  78. RP_MBOX_ECHO_REQUEST = 0xFFFFFF03,
  79. RP_MBOX_ECHO_REPLY = 0xFFFFFF04,
  80. RP_MBOX_ABORT_REQUEST = 0xFFFFFF05,
  81. RP_MBOX_SUSPEND_AUTO = 0xFFFFFF10,
  82. RP_MBOX_SUSPEND_SYSTEM = 0xFFFFFF11,
  83. RP_MBOX_SUSPEND_ACK = 0xFFFFFF12,
  84. RP_MBOX_SUSPEND_CANCEL = 0xFFFFFF13,
  85. RP_MBOX_END_MSG = 0xFFFFFF14,
  86. };
  87. #endif /* _OMAP_RPMSG_H */