Commit Graph

19 Commits

Author SHA1 Message Date
Peter Mitsis 859a4c8240 platform doc: Fix galileo content issues
Fixes minor content issues with the galileo documentation such as ...
  1. Avoid use of "Zephyr projects"
  2. Fix typos

Change-Id: Ie3e49cbebfe3cee819b85b005bb44916d6d96129
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:15:33 -05:00
Peter Mitsis 292ad9b757 platform doc: Fix fsl_frdm_k64f content issues
Fixes minor content issues with the fsl_frdm_k64f documentation such as ...
  1. Avoid use of "Zephyr projects"
  2. Fix referenced variable and file names
  3. Fix default value of NUM_IRQS Kconfig option
  4. Fix typos

Change-Id: Id5f2d219fab7ba184f0b1ae1c0d28894e69faacc
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:15:33 -05:00
Peter Mitsis 7cb19c9952 platform doc: Fix documentation build errors
Fixes multiple instances of the following build error:

    ERROR: Error in "code-block" directive:
    maximum 1 argument(s) allowed, 3 supplied.

The revised text avoids the use of code-blocks, and improves readability
by highlighting the supported combinations of configuration options.

Change-Id: I6f495bcc2e6bada096e5d117e9f886d4a9fb6269
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:15:33 -05:00
Peter Mitsis 0dcf0aad7f platform doc: Fix emphasis error
Adds a preceding backslash to the '*' character in C-like comments to ensure
that they are not interpreted as belonging to part of an emphasis block.

Change-Id: Iac9da1fc68ace0b9829e1b687c163baa81040718
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:15:33 -05:00
Peter Mitsis 648ca009ff platform doc: Standardize on note section formatting
Standardizes on the text formatting following a ".. note::" label.
  1. No blank line after the label.
  2. Uses an indentation of 3 spaces.

Change-Id: I9b28a88fef237fe5a8bb6eb2d6fb746f745598fd
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:15:33 -05:00
Peter Mitsis 1736809aee platform doc: Fix build warnings caused by unicode
Fixes multiple instances of the following build warning by updating the
platform documentation to no longer use a unicode equivalent to the ' character.

   WARNING: undecodable source characters, replacing with "?"

Change-Id: I226176cc4699be79692a3591c7b53772df6d1bef
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:15:33 -05:00
Peter Mitsis 17c83fe62e platform doc: Fix up minor issues in tables
Fixes up the following minor issues in the various tables in the fsl_frdm_k64f
and galileo documentation.
  1. Ensures that there is a space between the column '|' and text.
  2. Eliminates inconsistent italicizing of table text.
  3. Order of the "Interface" table matches "Supported Features"
  4. Ensures that items are correctly identified.

Fix tables in fsl_frdm_64kf platform documentation

Change-Id: I5d9127bdde2f2af285d4344a8def3a81a11deb76
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:15:33 -05:00
Peter Mitsis 73b066fc76 platform doc: Automate table of contents
Sections now make consistent use of the ####, ****, ====, and ----
headings so that the table of contents can be automatically generated
instead of relying upon a manually created table of contents.

Section names have been modified as necessary.

Change-Id: I57c2bb133de7ded07bb1e30d37c6a2850ccfb9c5
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:15:33 -05:00
Peter Mitsis 7752ddff16 platform doc: Clean up section names
Fixes up section names and the table of contents so that they align with
each other.  This necessitates a little reworking of content and relocation
of sections.

Change-Id: Ib9766f2090cf949eaf9a0d7686d496301b88a407
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:15:33 -05:00
Peter Mitsis d50f786145 doc: Rename quark platform configuration to galileo
Updates the documentation as the quark platform configuration had been
previously renamed to 'galileo'.

Change-Id: I31e1920f30f57b243b07215fe92be08b5e5c9d59
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:15:33 -05:00
Peter Mitsis ebe30b0348 doc: Provide basic_cortex_m3 platform documentation
Change-Id: If2f4f6352f0ac9f4c1fcc2246b8001965232822d
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:15:33 -05:00
Peter Mitsis 3efb572a3f doc: Provide basic_minuteia platform documentation
Change-Id: Ib1a17e2cc0f54b900fc285202fd6850d360fa6a2
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:15:33 -05:00
Peter Mitsis dd8187f6ae doc: Provide basic_atom platform documentation
Change-Id: I76051da6ad590192fc94c16b52ed462575b3c2c3
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:15:33 -05:00
Peter Mitsis c822760c43 doc: cosmetic cleanup to platform development primer
Except for the table, lines are now 80 characters or less.

Change-Id: I023f68b358806970899dd70a6cd49a0bee403dfa
Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-02-05 20:15:33 -05:00
Benjamin Walsh 179f805322 doc: correct 'interrupts' section of fsl_frdm_k64f
Change-Id: I0c0aad54c3e9a386428443b1cbf2c7c447576743
Signed-off-by: Benjamin Walsh <benjamin.walsh@windriver.com>
2016-02-05 20:15:25 -05:00
Benjamin Walsh c1f9fd888d irq: make utility functions private
irq_handler_set, irq_priority_set and irq_disconnect have been made
private by prepending an underscore to their names:

	irq_handler_set -> irq_handler_set
	irq_priority_set -> irq_priority_set
	irq_disconnect -> irq_disconnect

The prototypes have been removed from header files when possible, and
extern statements used in C code where they were called.

_irq_priority_set() for ARM is still in the header file because
IRQ_CONFIG() relies on it.

Change-Id: I2ad585f8156ff80250f6d9eeca4a249a4477fd9d
Signed-off-by: Benjamin Walsh <benjamin.walsh@windriver.com>
2016-02-05 20:15:21 -05:00
Rodrigo Caballero 4e472fa2fe Doc: Add the Platform Development Primer to the structure.
The content of the files was left unchanged except for labels for
cros-referncing, the main title of the part and the tabs on the tables
which were changed to spaces. That last change ensures the integrity of
the tables independently of editor. The structure of the content files
will be revised at a later time.

Change-Id: I90477966fb3f4727d61e859d77682b529c83337d
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
2016-02-05 20:15:19 -05:00
Carol Lee 9f8ce095b8 Quark Platform Configuration documentation
Adds new Quark platform configuration documentation to support the Galileo board.

Change-Id: I00ccc01ee75dbd54721d2d36583e9c7626e237d8
Signed-off-by: Carol Lee <carol.lee@windriver.com>
2016-02-05 20:14:33 -05:00
Carol Lee a74b4fa277 doc: Initial platform configuration guides
Adds infrastructure for platform configuration guides,
starting with the fsl_frdm_k64f platform configuration.

Incorporates inline sphynx tags except :guilabel:
which does not bold gui labels, a feature needed
for scanning a procedure for key info.

Change-Id: I4f5154dae896449fb709842501c69d8757deca3e
Signed-off-by: Carol Lee <carol.lee@windriver.com>
2016-02-05 20:14:33 -05:00