EmbDev.net

Forum: ARM programming with GCC/GNU tools documentation for at91xxx ?


Author: Documentation for at91xxx ? (Guest)
Posted on:

Rate this post
0 useful
not useful
Greetings,
   I work with at91sam7s128 with winarm compiler. My question is where 
can i find documentation for all winarm functions - what is the meaning 
of every function(such as AT91F_PMC_EnablePeriphClock() and so on) and 
what parameters are required.
                                                        Michael

Author: Clifford Slocombe (clifford)
Posted on:

Rate this post
0 useful
not useful
Documentation for at91xxx ? wrote:
> can i find documentation for all winarm functions -

You seem to misunderstand the nature of WinARM.  It is a collection of 
components from several open source projects and device vendor supplied 
code.  There are no "winarm functions"

> what is the meaning of every function(such as
> AT91F_PMC_EnablePeriphClock() and so on) and
> what parameters are required.

That particular function is specific to AT91 devices.  You should check 
the header file in which it is declared to determine its author, and 
then contact them or their web-site for documentation.  Often the 
documentation you need is in fact contained in the header file.

In this case it is almost certainly the device vendor supplied library 
(I Googled it).  For example lib_AT91SAM7S128.h declared the function 
thus:


//*--------------------------------------------------------------------- 
-------
//* \fn    AT91F_PMC_EnablePeriphClock
//* \brief Enable peripheral clock
//*--------------------------------------------------------------------- 
-------
__inline void AT91F_PMC_EnablePeriphClock (
    AT91PS_PMC pPMC, // \arg pointer to PMC controller
    unsigned int periphIds)  // \arg IDs of peripherals to enable
{
    pPMC->PMC_PCER = periphIds;
}

As you can see it is inlined, so you can see exactly what it does, and 
is fully commented.  The comments appear to have some sort of mark-up 
(JavaDoc perhaps?) which would be used for automatically generating 
documentation, so the actual documentation would include no more than 
this in any case.

The full library and documentation is available from 
http://www.atmel.com/dyn/products/tools_card.asp?t...

For the record, the function enables individual peripherals; disabling 
unused peripherals saves power.  To understand what it is actually 
doing, and the necessary values for the arguments, you need to be 
familiar with the specific devices reference or user manual; available 
in this case from Atmel's website 
(http://www.atmel.com/dyn/resources/prod_documents/...).

Clifford

Author: Documentation for at91xxx ? (Guest)
Posted on:

Rate this post
0 useful
not useful
Thank you very much for your detailed answer.
                                                                                                    Michael

Reply

Entering an e-mail address is optional. If you want to receive reply notifications by e-mail, please log in.

Rules — please read before posting

  • Post long source code as attachment, not in the text
  • Posting advertisements is forbidden.

Formatting options

  • [c]C code[/c]
  • [avrasm]AVR assembler code[/avrasm]
  • [code]code in other languages, ASCII drawings[/code]
  • [math]formula (LaTeX syntax)[/math]




Bild automatisch verkleinern, falls nötig
Note: the original post is older than 6 months. Please don't ask any new questions in this thread, but start a new one.