configration pf edma3 rm

Configuration of EDMA3 RM in Framework Components 1 Configuration of EDMA3 RM in Framework Components Introduction This information pertains to FC 2.10 or above. Algorithms that require EDMA3 resources (including EDMA channels, QDMA channels, Tccs and PaRams) can implement the IRES interface (in particular the IRES_EDMA3CHAN interface) to be able to request and receive these resources in the form of IRES handles (IRES_EDMA3CHAN_Handle). Algorithms then use the IRES handles with a customized DMA library to perform EDMA/QDMA transfers. RMAN queries the algorithms' IRES_EDMA3CHAN interface and grants them available resources depending on what its "registered" resource manager is configured with. The corresponding resource manager for EDMA3 resources is IRESMAN_EDMA3CHAN. This resource manager has to be registered with RMAN by the application whenever the algorithms being instantiated require IRES EDMA3CHAN resources. IRESMAN_EDMA3CHAN resource manager, in turn, talks to the EDMA3 Low Level Resource Manager (part of the EDMA3 Low Level Driver product) to obtain resources. All entities on the system that require EDMA3 resources (Apps, drivers, algorithms etc) are encouraged to negotiate their resources from this common underlying EDMA3 Low Level Resource Manager to avoid resource conflicts between multiple users of the EDMA3. Framework Components is also migrating towards using the EDMA3 Low Level Resource Manager to obtain EDMA3 resources for its DMA managers (DMAN3 and IRESMAN_EDMA3CHAN). A common EDMA3 Meta config module is now included as part of the Framework Components library that configures the EDMA3 Low Level Resource Manager. Other modules (such as IRESMAN_EDMA3CHAN, and in future, the DMAN3) can now talk to this module to obtain available EDMA3 resources. This module, ti.sdo.fc.edma3.Settings also understands and supports the notion of Scratch Groups. Hence, whenever you application uses RMAN and runs creates algorithms that request EDMA3 resources using their IRES interface, you will need to configure the "EDMA3" module ti.sdo.fc.edma3.Settings. Configuration of ti.sdo.fc.edma3.Settings As mentioned above, the EDMA3 Low Level Resource Manager can be configured using the ti.sdo.fc.edma3.Settings module. Following are the configuration parameters of this module and a brief description of them:- Name Type Default Description region UInt 1 Id of the EDMA3 Region we will program with the assigned Resources etc. Region number 1 usually corresponds to DSP. globalInit Bool false This flag decides if EDMA3 global registers and PaRam entries will be initialized by this module. If using on a device where ARM-side drivers might perform the intialization, set this to false so it doesn't overwrite the ARM-side setup. This decides values to various paramters that are used to initialize that EDMA LLD RM. These paramters are basically hints to whether the LLD RM should initialize any registers or PaRams during allocation and freeing or resources EDMA3_MAXGROUPS const UInt 20 Maximum number of scratch groups for sharing EDMA3 resources Configuration of EDMA3 RM in Framework Components 2 maxTccs UInt[] [10,10,10,10,0,0,0,0...] Arrays containing the maximum number of TCCs that will be assigned to groups for sharing. Algorithms created within a given group ID will share the EDMA3 resources assigned to that group maxPaRams UInt[] [20,20,20,20,0,0,0,0...] Arrays containing the maximum number of PaRams that will be assigned to groups for sharing. Algorithms created within a given group ID will share the EDMA3 resources assigned to that group maxEdmaChannels UInt[] [4,4,4,5,0,0,0,0...] Arrays containing the maximum number of EDMA Channels that will be assigned to groups for sharing. Algorithms created within a given group ID will share the EDMA3 resources assigned to that group maxQdmaChannels UInt[] [1,1,1,1,0,0,0,0...] Arrays containing the maximum number of QDMA Channels that will be assigned to groups for sharing. Algorithms created within a given group ID will share the EDMA3 resources assigned to that group contiguousPaRams Bool true Indicates if PaRams assigned to scratch groups need to be contiguous or not globalConfig String null Global configuration required to set the SOC specific configuratin of the EDMA3 device. If set to NULL, it picks up the default configuration for the particular SOC that the application is being built on. To alter this value, you would create a variable of the type EDMA3_RM_GblConfigParams (defined in ti/sdo/edma3/rm/edma3_rm.h) and set appropriate values in the fields. Set parameter globalConfig to the address of this structure regionConfig String null Instance specific configuration required to set the region specific resource ownership details of the EDMA3 device. If set to NULL, it picks up the default configuration for the particular SOC and region number (See paramter region above) that the application is being built on/configured with. To alter this value, you would create a variable of the type EDMA3_RM_InstanceInitConfig (defined in ti/sdo/edma3/rm/edma3_rm.h) and set appropriate bitmasks in the fields. Set parameter regionConfig to the address of this structure persistentAllocFxn String null extern Bool () (IALG_MemRec *memTab, Int numRecs); Function for allocating persistent memory for allocating internal objects for this module. If this parameter is already set for the ti.sdo.fc.rman module, this doesn't need to be set here. Also if the RMAN module's useDSKT2 paramter is set to true, again this parameter is not required to be set. persistentFreeFxn String null extern Void () (IALG_MemRec *memTab, Int numRecs); Function for freeing persistent memory allocated by persistentAllocFxn. If this parameter is already set for the ti.sdo.fc.rman module, this doesn't need to be set here. Also if the RMAN module's useDSKT2 paramter is set to true, again this parameter is not required to be set. semCreateFxn String null Void * () (Int key, Int count); Function to create semaphores required by the EDMA3 LLD RM. If this parameter is already set for the ti.sdo.fc.rman module, this doesn't need to be set here. semDeleteFxn String null Void () (Void * sem); Function to free semaphores created by semCreateFxn. If this parameter is already set for the ti.sdo.fc.rman module, this doesn't need to be set here. semPendFxn String null Int () (Void * sem, unsigned int timeout); Function to post_semaphores created by _semCreateFxn. If this parameter is already set for the ti.sdo.fc.rman module, this doesn't need to be set here. semPostFxn String null Void () (Void * sem); Function to post_semaphores created by _semCreateFxn. If this parameter is already set for the ti.sdo.fc.rman module, this doesn't need to be set here. maxAlgs UInt 32 Maximum number of algorithm instances that will be created. debug bool false Enable the debug profile of this library. Larger and slower library will be linked in. trace bool false Enable the trace profile of this library. Article Sources and Contributors 3 Article Sources and Contributors Configuration of EDMA3 RM in Framework Components  Source: http://processors.wiki.ti.com/index.php?oldid=42047  Contributors: ChrisRing, Vincent Wan License THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED. BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LICENSE MAY BE CONSIDERED TO BE A CONTRACT, THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS. License 1. Definitions 1. "Adaptation" means a work based upon the Work, or upon the Work and other pre-existing works, such as a translation, adaptation, derivative work, arrangement of music or other alterations of a literary or artistic work, or phonogram or performance and includes cinematographic adaptations or any other form in which the Work may be recast, transformed, or adapted including in any form recognizably derived from the original, except that a work that constitutes a Collection will not be considered an Adaptation for the purpose of this License. For the avoidance of doubt, where the Work is a musical work, performance or phonogram, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered an Adaptation for the purpose of this License. 2. "Collection" means a collection of literary or artistic works, such as encyclopedias and anthologies, or performances, phonograms or broadcasts, or other works or subject matter other than works listed in Section 1(f) below, which, by reason of the selection and arrangement of their contents, constitute intellectual creations, in which the Work is included in its entirety in unmodified form along with one or more other contributions, each constituting separate and independent works in themselves, which together are assembled into a collective whole. A work that constitutes a Collection will not be considered an Adaptation (as defined below) for the purposes of this License. 3. "Creative Commons Compatible License" means a license that is listed at http:/ / creativecommons. org/ compatiblelicenses that has been approved by Creative Commons as being essentially equivalent to this License, including, at a minimum, because that license: (i) contains terms that have the same purpose, meaning and effect as the License Elements of this License; and, (ii) explicitly permits the relicensing of adaptations of works made available under that license under this License or a Creative Commons jurisdiction license with the same License Elements as this License. 4. "Distribute" means to make available to the public the original and copies of the Work or Adaptation, as appropriate, through sale or other transfer of ownership. 5. "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike. 6. "Licensor" means the individual, individuals, entity or entities that offer(s) the Work under the terms of this License. 7. "Original Author" means, in the case of a literary or artistic work, the individual, individuals, entity or entities who created the Work or if no individual or entity can be identified, the publisher; and in addition (i) in the case of a performance the actors, singers, musicians, dancers, and other persons who act, sing, deliver, declaim, play in, interpret or otherwise perform literary or artistic works or expressions of folklore; (ii) in the case of a phonogram the producer being the person or legal entity who first fixes the sounds of a performance or other sounds; and, (iii) in the case of broadcasts, the organization that transmits the broadcast. 8. "Work" means the literary and/or artistic work offered under the terms of this License including without limitation any production in the literary, scientific and artistic domain, whatever may be the mode or form of its expression including digital form, such as a book, pamphlet and other writing; a lecture, address, sermon or other work of the same nature; a dramatic or dramatico-musical work; a choreographic work or entertainment in dumb show; a musical composition with or without words; a cinematographic work to which are assimilated works expressed by a process analogous to cinematography; a work of drawing, painting, architecture, sculpture, engraving or lithography; a photographic work to which are assimilated works expressed by a process analogous to photography; a work of applied art; an illustration, map, plan, sketch or three-dimensional work relative to geography, topography, architecture or science; a performance; a broadcast; a phonogram; a compilation of data to the extent it is protected as a copyrightable work; or a work performed by a variety or circus performer to the extent it is not otherwise considered a literary or artistic work. 9. "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation. 10. "Publicly Perform" means to perform public recitations of the Work and to communicate to the public those public recitations, by any means or process, including by wire or wireless means or public digital performances; to make available to the public Works in such a way that members of the public may access these Works from a place and at a place individually chosen by them; to perform the Work to the public by any means or process and the communication to the public of the performances of the Work, including by public digital performance; to broadcast and rebroadcast the Work by any means including signs, sounds or images. 11. "Reproduce" means to make copies of the Work by any means including without limitation by sound or visual recordings and the right of fixation and reproducing fixations of the Work, including storage of a protected performance or phonogram in digital form or other electronic medium. 2. Fair Dealing Rights Nothing in this License is intended to reduce, limit, or restrict any uses free from copyright or rights arising from limitations or exceptions that are provided for in connection with the copyright protection under copyright law or other applicable laws. 3. License Grant Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below: 1. to Reproduce the Work, to incorporate the Work into one or more Collections, and to Reproduce the Work as incorporated in the Collections; 2. to create and Reproduce Adaptations provided that any such Adaptation, including any translation in any medium, takes reasonable steps to clearly label, demarcate or otherwise identify that changes were made to the original Work. For example, a translation could be marked "The original work was translated from English to Spanish," or a modification could indicate "The original work has been modified."; 3. to Distribute and Publicly Perform the Work including as incorporated in Collections; and, 4. to Distribute and Publicly Perform Adaptations. 5. For the avoidance of doubt: 1. Non-waivable Compulsory License Schemes. In those jurisdictions in which the right to collect royalties through any statutory or compulsory licensing scheme cannot be waived, the Licensor reserves the exclusive right to collect such royalties for any exercise by You of the rights granted under this License; 2. Waivable Compulsory License Schemes. In those jurisdictions in which the right to collect royalties through any statutory or compulsory licensing scheme can be waived, the Licensor waives the exclusive right to collect such royalties for any exercise by You of the rights granted under this License; and, 3. Voluntary License Schemes. The Licensor waives the right to collect royalties, whether individually or, in the event that the Licensor is a member of a collecting society that administers voluntary licensing schemes, via that society, from any exercise by You of the rights granted under this License. The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. Subject to Section 8(f), all rights not expressly granted by Licensor are hereby reserved. 4. Restrictions The license granted in Section 3 above is expressly made subject to and limited by the following restrictions: 1. You may Distribute or Publicly Perform the Work only under the terms of this License. You must include a copy of, or the Uniform Resource Identifier (URI) for, this License with every copy of the Work You Distribute or Publicly Perform. You may not offer or impose any terms on the Work that restrict the terms of this License or the ability of the recipient of the Work to exercise the rights granted to that recipient under the terms of the License. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties with every copy of the Work You Distribute or Publicly Perform. When You Distribute or Publicly Perform the Work, You may not impose any effective technological measures on the Work that restrict the ability of a recipient of the Work from You to exercise the rights granted to that recipient under the terms of the License. This Section 4(a) applies to the Work as incorporated in a Collection, but this does not require the Collection apart from the Work itself to be made subject to the terms of this License. If You create a Collection, upon notice from any Licensor You must, to the extent practicable, remove from the Collection any credit as required by Section 4(c), as requested. If You create an Adaptation, upon notice from any Licensor You must, to the extent practicable, remove from the Adaptation any credit as required by Section 4(c), as requested. 2. You may Distribute or Publicly Perform an Adaptation only under the terms of: (i) this License; (ii) a later version of this License with the same License Elements as this License; (iii) a Creative Commons jurisdiction license (either this or a later license version) that contains the same License Elements as this License (e.g., Attribution-ShareAlike 3.0 US)); (iv) a Creative Commons Compatible License. If you license the Adaptation under one of the licenses mentioned in (iv), you must comply with the terms of that license. If you license the Adaptation under the terms of any of the licenses mentioned in (i), (ii) or (iii) (the "Applicable License"), you must comply with the terms of the Applicable License generally and the following provisions: (I) You must include a copy of, or the URI for, the Applicable License with every copy of each Adaptation You Distribute or Publicly Perform; (II) You may not offer or impose any terms on the Adaptation that restrict the terms of the Applicable License or the ability of the recipient of the Adaptation to exercise the rights granted to that recipient under the terms of the Applicable License; (III) You must keep intact all notices that refer to the Applicable License and to the disclaimer of warranties with every copy of the Work as included in the Adaptation You Distribute or Publicly Perform; (IV) when You Distribute or Publicly Perform the Adaptation, You may not impose any effective technological measures on the Adaptation that restrict the ability of a recipient of the Adaptation from You to exercise the rights granted to that recipient under the terms of the Applicable License. This Section 4(b) applies to the Adaptation as incorporated in a Collection, but this does not require the Collection apart from the Adaptation itself to be made subject to the terms of the Applicable License. 3. If You Distribute, or Publicly Perform the Work or any Adaptations or Collections, You must, unless a request has been made pursuant to Section 4(a), keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or if the Original Author and/or Licensor designate another party or parties (e.g., a sponsor institute, publishing entity, journal) for attribution ("Attribution Parties") in Licensor's copyright notice, terms of service or by other reasonable means, the name of such