Vayu: Enable configuration of IPU mailbox virt addrs 3.00.01.22_eng
authorChris Ring <cring@ti.com>
Fri, 7 Jun 2013 21:59:17 +0000 (14:59 -0700)
committerChris Ring <cring@ti.com>
Sun, 9 Jun 2013 22:46:57 +0000 (15:46 -0700)
IPC must access the physical mailbox addresses (physically
at 0x4XXX_XXXX) via virtual addresses (typically set up
using the IPU's AMMU).  System integrators need the
flexibility to place these mailboxes at different virtual
addresses.

System integrators can now use the InteruptIpu.mailboxBaseAddr[]
config params to place these mailboxes at virtual
addresses other than the default (which is 0x6XXX_XXXX).

Also clarified the cdoc documentation.

Signed-off-by: Chris Ring <cring@ti.com>
packages/ti/sdo/ipc/family/vayu/InterruptIpu.xdc
packages/ti/sdo/ipc/family/vayu/InterruptIpu.xs

index a3eda0f963ea1569b713340d837a58bd12f65615..6f029618a47c066e33a890cda47b02072c5c50d8 100644 (file)
@@ -38,40 +38,105 @@ import ti.sdo.utils.MultiProc;
 
 /*!
  *  ======== InterruptIpu ========
- *  TI81xx/Ducati based interrupt manager
+ *  IPU interrupt manager
  */
 
 @ModuleStartup
 
 module InterruptIpu inherits ti.sdo.ipc.notifyDrivers.IInterrupt
 {
-    /* Total number of cores on Vayu SoC */
+    /*!
+     *  Maximum number of cores
+     *
+     *  @_nodoc
+     */
     const UInt8 NUM_CORES = 11;
 
-    /* Number of Cores in EVE Sub-system */
+    /*!
+     *  Maximum number of EVE cores
+     *
+     *  Although your device may have fewer EVE cores, `NUM_EVES` represents
+     *  the maximum number of EVEs that may be present on a Vayu system.
+     */
     const UInt8 NUM_EVES = 4;
 
-    /* Number of Cores in Ipu Sub-system */
+    /*!
+     *  Maximum number of IPU cores
+     *
+     *  @_nodoc
+     */
     const UInt8 NUM_Ipu_CORES = 2;
 
-    /* Number of Internal EVE mailboxes */
-    const UInt8 NUM_EVE_MBX = 12;
+    /*!
+     *  Number of internal EVE mailboxes
+     *
+     *  Each EVE core has 3 mailboxes.
+     *
+     *  Although your device may have fewer EVE cores, `NUM_EVE_MBX` represents
+     *  the maximum number of EVE mailboxes (including all EVE cores) that may
+     *  be present.
+     */
+    const UInt8 NUM_EVE_MBX = NUM_EVES * 3;
 
-    /* Number of System Mailboxes */
+    /*!
+     *  Number of System mailboxes used by IPC
+     *
+     *  This represents the number of System mailboxes used by IPC.  IPC
+     *  currently uses system mailboxes 5, 6, 7 and 8.
+     */
     const UInt8 NUM_SYS_MBX = 4;
 
-    /* Base address for the Mailbox subsystem */
+    /*!
+     *  Base address for the mailbox subsystems
+     *
+     *  The `mailboxBaseAddr` array indicates the virtual addresses through
+     *  which IPC will access various mailboxes.  The specific mailbox addresses
+     *  each array index maps to follows:
+     *  @p(blist)
+     *    - 0  - EVE1 MBX0
+     *    - 1  - EVE1 MBX1
+     *    - 2  - EVE1 MBX2 (unused, do not assign)
+     *    - 3  - EVE2 MBX0
+     *    - 4  - EVE2 MBX1
+     *    - 5  - EVE2 MBX2 (unused, do not assign)
+     *    - 6  - EVE3 MBX0
+     *    - 7  - EVE3 MBX1
+     *    - 8  - EVE1 MBX2 (unused, do not assign)
+     *    - 9  - EVE4 MBX0
+     *    - 10 - EVE4 MBX1
+     *    - 11 - EVE1 MBX2 (unused, do not assign)
+     *    - 12  - System Mailbox 5
+     *    - 13  - System Mailbox 6
+     *    - 14  - System Mailbox 7
+     *    - 15  - System Mailbox 8
+     *  @p
+     *
+     *  Note that these mailboxes are not accessible at their physical
+     *  addresses (in the 0x4XXX_XXXX range).  So default virtual addresses
+     *  through which these mailboxes will be accessed are assigned in the
+     *  0x6XXX_XXXX range.  Users must ensure these virtual addresses are
+     *  correctly mapped to the 0x4XXX_XXXX-based phys addrs in each IPUs AMMU.
+     */
     config UInt32 mailboxBaseAddr[NUM_EVE_MBX + NUM_SYS_MBX];
 
-    /*
+    /*!
      * Mailbox table for storing encoded Base Address, mailbox user Id,
      * and sub-mailbox index.
+     *
+     *  @_nodoc
      */
     config UInt32 mailboxTable[NUM_CORES * NUM_CORES];
 
-    /* Base address for the Ducati CTRL register */
+    /*!
+     *  Base address for the Ducati CTRL register
+     */
     config UInt32 ducatiCtrlBaseAddr = 0x40001000;
 
+    /*!
+     *  Processor Id table
+     *
+     *  @_nodoc
+     */
     config UInt32 procIdTable[NUM_CORES];
 
 internal:
index 0aa31791b923171eabdff08b00a78b2eabdbb9bd..76751460b21c866f39089ca411cb98c3e8b088f3 100644 (file)
@@ -58,28 +58,74 @@ function module$use()
     /* Initialize mailboxTable */
     TableInit.generateTable(Ipu);
 
-    /*
-     * Initialize mailbox base address table
-     *
-     * Note, these are Virtual addrs, which the user must correctly map to
-     * phys addrs in the AMMU!
-     */
-    this.mailboxBaseAddr[0]  = 0x6208B000;  /* EVE1 MBOX0 - PA: 0x4208B000 */
-    this.mailboxBaseAddr[1]  = 0x6208C000;  /*          1 - PA: 0x4208C000 */
-    this.mailboxBaseAddr[2]  = 0x6208D000;  /*          2 - PA: N/A        */
-    this.mailboxBaseAddr[3]  = 0x6218B000;  /* EVE2 MBOX0 - PA: 0x4218B000 */
-    this.mailboxBaseAddr[4]  = 0x6218C000;  /*          1 - PA: 0x4218C000 */
-    this.mailboxBaseAddr[5]  = 0x6218D000;  /*          2 - PA: N/A        */
-    this.mailboxBaseAddr[6]  = 0x6228B000;  /* EVE3 MBOX0 - PA: 0x4228B000 */
-    this.mailboxBaseAddr[7]  = 0x6228C000;  /*          1 - PA: 0x4228C000 */
-    this.mailboxBaseAddr[8]  = 0x6228D000;  /*          2 - PA: N/A        */
-    this.mailboxBaseAddr[9]  = 0x6238B000;  /* EVE4 MBOX0 - PA: 0x4238B000 */
-    this.mailboxBaseAddr[10] = 0x6238C000;  /*          1 - PA: 0x4238C000 */
-    this.mailboxBaseAddr[11] = 0x6238D000;  /*          2 - PA: N/A        */
-    this.mailboxBaseAddr[12] = 0x68840000;  /* System Mailbox 5 */
-    this.mailboxBaseAddr[13] = 0x68842000;  /* System Mailbox 6 */
-    this.mailboxBaseAddr[14] = 0x68844000;  /* System Mailbox 7 */
-    this.mailboxBaseAddr[15] = 0x68846000;  /* System Mailbox 8 */
+    /* Initialize mailbox base addrs */
+    if (this.mailboxBaseAddr[0] == undefined) {
+        this.mailboxBaseAddr[0]  = 0x6208B000;  /* EVE1 MBOX0 - PA: 0x4208B000 */
+    }
+    if (this.mailboxBaseAddr[1] == undefined) {
+        this.mailboxBaseAddr[1]  = 0x6208C000;  /* EVE1 MBOX1 - PA: 0x4208C000 */
+    }
+    if (this.mailboxBaseAddr[2] == undefined) {
+        this.mailboxBaseAddr[2]  = 0;           /* EVE1 MBOX2 - PA: N/A        */
+    } else {
+        this.$logWarning("InterruptIpu.mailboxBaseAddr[2] is the EVE1 MBOX2, " +
+                "which is not used for IPU communication and should not be " +
+                "configured.", this);
+    }
+    if (this.mailboxBaseAddr[3] == undefined) {
+        this.mailboxBaseAddr[3]  = 0x6218B000;  /* EVE2 MBOX0 - PA: 0x4218B000 */
+    }
+    if (this.mailboxBaseAddr[4] == undefined) {
+        this.mailboxBaseAddr[4]  = 0x6218C000;  /* EVE2 MBOX1 - PA: 0x4218C000 */
+    }
+    if (this.mailboxBaseAddr[5] == undefined) {
+        this.mailboxBaseAddr[5]  = 0;           /* EVE2 MBOX2 - PA: N/A        */
+    } else {
+        this.$logWarning("InterruptIpu.mailboxBaseAddr[5] is the EVE2 MBOX2, " +
+                "which is not used for IPU communication and should not be " +
+                "configured.", this);
+    }
+
+    if (this.mailboxBaseAddr[6] == undefined) {
+        this.mailboxBaseAddr[6]  = 0x6228B000;  /* EVE3 MBOX0 - PA: 0x4228B000 */
+    }
+    if (this.mailboxBaseAddr[7] == undefined) {
+        this.mailboxBaseAddr[7]  = 0x6228C000;  /* EVE3 MBOX1 - PA: 0x4228C000 */
+    }
+    if (this.mailboxBaseAddr[8] == undefined) {
+        this.mailboxBaseAddr[8]  = 0;           /* EVE3 MBOX2 - PA: N/A        */
+    } else {
+        this.$logWarning("InterruptIpu.mailboxBaseAddr[8] is the EVE3 MBOX2, " +
+                "which is not used for IPU communication and should not be " +
+                "configured.", this);
+    }
+
+    if (this.mailboxBaseAddr[9] == undefined) {
+        this.mailboxBaseAddr[9]  = 0x6238B000;  /* EVE4 MBOX0 - PA: 0x4238B000 */
+    }
+    if (this.mailboxBaseAddr[10] == undefined) {
+        this.mailboxBaseAddr[10]  = 0x6238C000; /* EVE4 MBOX1 - PA: 0x4238C000 */
+    }
+    if (this.mailboxBaseAddr[11] == undefined) {
+        this.mailboxBaseAddr[11]  = 0;          /* EVE4 MBOX2 - PA: N/A        */
+    } else {
+        this.$logWarning("InterruptIpu.mailboxBaseAddr[11] is the EVE4 MBOX2, " +
+                "which is not used for IPU communication and should not be " +
+                "configured.", this);
+    }
+
+    if (this.mailboxBaseAddr[12] == undefined) {
+        this.mailboxBaseAddr[12] = 0x68840000;  /* System Mailbox 5 */
+    }
+    if (this.mailboxBaseAddr[13] == undefined) {
+        this.mailboxBaseAddr[13] = 0x68842000;  /* System Mailbox 6 */
+    }
+    if (this.mailboxBaseAddr[14] == undefined) {
+        this.mailboxBaseAddr[14] = 0x68844000;  /* System Mailbox 7 */
+    }
+    if (this.mailboxBaseAddr[15] == undefined) {
+        this.mailboxBaseAddr[15] = 0x68846000;  /* System Mailbox 8 */
+    }
 
     /*
      * In case of a spec change, follow the process shown below: