summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2016-10-26unified: update kernel event logger docBenjamin Walsh
- replace instances of 'task' and 'fiber' with 'coop' and 'preempt' thread - remove reference to task monitor and task transition logging, since this is a concept that is irrelevent in the unified kernel. Change-Id: I31eef8d7894c45183f6a13cc3fdaa2e6214e8da3 Signed-off-by: Benjamin Walsh <benjamin.walsh@windriver.com>
2016-10-25unified/doc: Add heap memory pool section to Kernel PrimerAllan Stephens
Change-Id: Ia55731d1fbc3aae2ee701eace3609b6222e8a1e4 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-10-25unified: Align thread creation APIsAllan Stephens
Aligns the APIs for defining a thread at compile time and for spawning a thread at run time. Change-Id: Ic5df450cbe4d0eb562fb4a608f1ac5a8a7cb4b96 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-10-24unified: Update k_stack_pop() usage in documentationPeter Mitsis
Change-Id: I909fc6b56a5e15e0bc9490e79ea7fb822bcbb325 Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-10-24doc: point to wiki for board documnetationAnas Nashif
Change-Id: I16dce8733d9fb6c4a5b28f6fe2c4cd30824ee699 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-10-21unified/doc: Update ring buffers section of Kernel PrimerAllan Stephens
Ring buffer section now resides under "other" topic, since the ring buffer type is a general purpose type (like the singly and doubly linked list types), rather than a kernel-specific type. Enhances ring buffer section to improve content and improve consistency with the form used elsewhere in the Kernel Primer. Also corrects a minor error in the ring buffer API documentation. Change-Id: Icaa8661524f80e31f173adee859844cadb38967f Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-10-21doc: fix name of DEFINE_MEM_MAP in documentationRohit Grover
Documentation is using an incorrect name for the macro available to allocate memory maps. Change-Id: Ic2a93d3851219cb91f3c9c01e2aa19e38913abdd Signed-off-by: Rohit Grover <rohit.grover@arm.com>
2016-10-21doc: Update driver documentation to reflect const config_info.Marcus Shawcroft
Change-Id: I85edb0b853a38f2093ea2dc0f7fc53a39010c2d2 Signed-off-by: Marcus Shawcroft <marcus.shawcroft@arm.com>
2016-10-19unified/doc: Update timing section of Kernel PrimerAllan Stephens
Revises documentation for the kernel clocks to align it with the actual behavior of the unified kernel. Revises documentation for the kernel timer object type to provide users with a more compact and intuitive API that supports (directly or indirectly) the capabilities of the now defunct microkernel timer and nanokernel timer object types. Note: A separate commit will be used to implement the revised timer API described here. Change-Id: Ifa4306c76e1c3e2aab1c0b55031df4179ac2a6b9 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-10-19unified: Tweak msgq API parametersPeter Mitsis
- Reorders parameters where necessary - Adds alignment parameter to K_MSGQ_DEFINE() for buffer alignment - Renames parameters where necessary so they are more intuitive Change-Id: I0b53105c04109127897bf4790e6908082f82da4e Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-10-19unified: Add k_msgq_num_free_get() APIPeter Mitsis
Complements existing k_msgq_num_used_get(). Change-Id: If04a540878ae998ccdc14867a022c428947604a6 Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-10-18unified: Tweak mem_map API parametersPeter Mitsis
- Reorders parameters where necessary - Adds buffer alignment parameter to K_MEM_MAP_DEFINE() Change-Id: Ifa1a09c62492cd6db8bdd83f31a5ca5ba072b484 Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-10-18unified: Add k_mem_map_num_free_get()Peter Mitsis
Complements existing k_mem_map_num_used_get(). Change-Id: Ie69c0a8e30007e365820448bde48303718369904 Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-10-18unified: Tweak K_MEMORY_POOL_DEFINE() macroPeter Mitsis
- Renames to K_MEM_POOL_DEFINE() for consistency - Adds alignment parameter to align the pool buffer. Jira: ZEP-926 Change-Id: I6cf0a1ce45c3a0fc5f0675047d8928659df1e75e Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-10-15unified: Tweak pipe API parametersPeter Mitsis
- Reorders parameters where necessary - Adds alignment parameter to K_PIPE_DEFINE() - Renames parameters where necessary so they are sync'd between header and source files Change-Id: I4f2367abc28aff646cc90beb9f08bb266e143b0c Signed-off-by: Peter Mitsis <peter.mitsis@windriver.com>
2016-10-11unified/doc: Update memory pools section of Kernel PrimerAllan Stephens
Also tweaks the memory maps section so that the two sections are laid out in a similar manner. Change-Id: I3abd69dd7e6c65cd1d6a4f12b3b14aa1b166ca5b Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-10-11unified/doc: Minor updates to thread sections in Kernel PrimerAllan Stephens
Change-Id: Id090413b51bf194b358c8b25e860af01368774a0 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-10-09unified/doc: Minor updates to event section of Kernel PrimerAllan Stephens
Change-Id: I4fec3439f930228a6bf94ee3aab49e3f65ecd043 Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-10-09unified/doc: Minor updates to message queues in Kernel PrimerAllan Stephens
Change-Id: I4e691f97818874d594ac1d9225c14f6af3c0101d Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
2016-10-07docs: Adjust driver documentation to show const config_info example.Marcus Shawcroft
The driver config structure should be const, that can't happen until various existing drivers are cleaned up, but it is safe for all drivers that use config_info to treat it as const. Update the drivers documentation to depict this usage. Change-Id: I01507759be7d5c347a0eaf8068636d4a39a243e2 Signed-off-by: Marcus Shawcroft <marcus.shawcroft@arm.com>
2016-10-05unified/doc: Kernel primer for unified kernelBenjamin Walsh
Work by: Allan Stephens Change-Id: I1f936cd6e7d592969f65330a6d204729ab0f32db Signed-off-by: Benjamin Walsh <benjamin.walsh@windriver.com>
2016-09-30ztest: Add documentationJaakko Hannikainen
Origin: Original Change-Id: I0927c25fbbba5d4863f199d058d311c10d52d784 Signed-off-by: Jaakko Hannikainen <jaakko.hannikainen@intel.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-09-30win-doc: Adds the dependency with the pthread libraryJuan Manuel Cruz
Jira: ZEP-779 Change-Id: If9f1714a28c8614fc82cc42c9835eaf4682ce09b Signed-off-by: Juan Manuel Cruz <juan.m.cruz.alcaraz@intel.com>
2016-09-30win-doc: Add recommendation for regex library configurationJuan Manuel Cruz
Jira: ZEP-779 Change-Id: I7a49be6f10959dae81e00d5dc66ef01463e88980 Signed-off-by: Juan Manuel Cruz <juan.m.cruz.alcaraz@intel.com>
2016-09-30boards: Rename the nRF52 Nitrogen to 96Boards NitrogenAmit Kucheria
Point to a new wiki page for the documentation. The old page can be removed once this patch is committed. Change-Id: I2b031bfffe10ec24c41c58d0754f2b14d95f5e53 Signed-off-by: Amit Kucheria <amit.kucheria@linaro.org>
2016-09-30doc: Update the device power management API documentationksimanto
Updated the device power management documentation to reflect the updated API. Change-Id: I6e4da7e1ae3642d28205504b8f19d9c8f9a08727 Signed-off-by: Keren Siman-Tov <keren.siman-tov@intel.com>
2016-09-28x86: interrupts: optimize and simplify IRQ stubsAndrew Boie
Interrupt stubs now just push the ISR and parameter onto the stack and jump to the common interrupt code, never to return. Change-Id: I82543d8148b5c7dfe116c43f41791f852614bb28 Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
2016-09-23kernel: remove lingering irq_connect_dynamic() referencesAndrew Boie
This API no longer exists. Change-Id: I724bee8c0ebfbbe2d47c00c7645977d817bbcd36 Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
2016-09-21doc: add zoap.h to doxygen inputAnas Nashif
Change-Id: I06cec65045782c3325fa8d2ec22f14a490275213 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-09-20doc: Add links from kernel API to overview docsDavid B. Kinder
API documentation wasn't linking to important conceptual overview material available in the primer documentation. This will need to be done over again when we work on the combined kernel documentation, but this will give us a peek at what that will look like. Jira: ZEP-746 Change-Id: Ib1142575272c72d93af8d409518d0d0a4304ef32 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2016-09-20doc: fix title generation for config options pagesDavid B. Kinder
Use the ReST metadata document title directive instead of embedded javascript to assign a title to the configuration options (Kconfig) reference guide pages. This will generate a static <title> directive in the generated HTML instead of relying on javascript. Change-Id: Ib70a8b1f641a5ed72be774f0f5b2a93a2d1c9b8c Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2016-09-17trivial: fixed typosAnas Nashif
Change-Id: Id374d5b738bac79cb5e0fd400f120b9c0daf4610 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-09-13doc: workaround for __deprecated functionsDavid B. Kinder
This edit to the doxygen.config file causes Doxygen to treat __deprecated as a predefined macro, which expands to nothing. See https://wiki.zephyrproject.org/view/Function_Documentation#Workarounds for further information about this workaround. Change-Id: I8e344cf65d7ff45609d5dd9a0caec14df9799d46 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2016-09-08doc: drivers: more details on Zephyr driver modelAndrew Boie
Issue: ZEP-199 Change-Id: I0f9a4029d5b0dbdd94322bbcaaad29071e508d2e Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
2016-09-08doc: Expand doc on 3rd-party cross compilersCarles Cufi
Add documentation for OS X users that want to compile using an available 3rd-party cross compiler and also complete the section to describe the existing support for the GCC ARM Embedded toolchain. Change-Id: I97d27d46c0048a49029dbe4d66fe141755c226e9 Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2016-09-07Bluetooth: Build RFCOMM documentationSzymon Janc
Change-Id: Iaba8fc321d73d66826d24f7f82d82d91ff0a250f Signed-off-by: Szymon Janc <ext.szymon.janc@tieto.com>
2016-09-07Bluetooth: Add documentation to HCI RAW interfaceAndrei Emeltchenko
Describe bt_enable_raw() and bt_send() functions. Change-Id: I0eb18dd2364eec0eb2a8c3e7b537d87e984dd90e Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
2016-09-06microkernel: remove deprecated task IRQsAndrew Boie
Change-Id: I02264a587b77ae597133b9c52b342b8e5520a131 Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
2016-08-30doxygen: ignore function attributesAndrew Boie
These needlessly confuse the parser. Define them as empty predefined macros. Change-Id: Iac6a909f278e1f8a757410612f64b1c46f67ff41 Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
2016-08-29doc: Add link to 1.5 tagged documentation on /doc homepageDavid B. Kinder
Each tagged version of the documentation associated with a build is available on the website. This patch adds the link to the 1.5.0 version. Change-Id: I664ec08598eacbdccbdfb1a5cec3791ea879edb0 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2016-08-27Make outdir board-specific to avoid build collisionsAndy Ross
Casual building in the tree leads to regular messups where I forget to clean up the outdir first when switching platforms and the build fails in strange ways. Put a $(BOARD) subdirectory under outdir, and use that at $(O) when the user does not provide an output directory. Note that "make pristine" continues to remove the entire outdir, including other architecutres (so as to make the tree pristine). Also update a few spots where outdir was mentioned in documentation to clarify the new scheme. Change-Id: I365eec06ea440f17380b9f9ace5f5d34b9bed4dc Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2016-08-24doc: Add more content for networking documentationJukka Rissanen
Jira: ZEP-687 Change-Id: Ic02f828dcc2a3994d537829832387c56f4c74ed2 Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
2016-08-22doc: remove 1.5 doc link until after releaseDavid B. Kinder
Link to the 1.5 version of documentation shouldn't be added to the documentation home page until AFTER the release documents are pushed to the site. (I thought this would have been done when the code freeze happened.) Remove the 1.5 link for now and wait until after the 1.5 docs are pushed. Jira: ZEP-730 Change-Id: Ia225c9ce3ffb52540fb43f105a3cd40e72d0cf4a Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2016-08-12doc: Terminology--Replace 'platform' with 'board'viggo.jf.intel.com
Replaced the term "platform" with "board" or "SoC" depending on context as per, ZEP-534. Change-Id: I14c13d4eed429fe6e41e2221d6ff6afe97e942eb Signed-off-by: Evan Couzens <evanx.couzens@intel.com>
2016-08-05doc: removed unneeded variable from guideGenaro Saucedo Tejada
Mac OS X guide had an unneeded transient variable. JIRA: ZEP-616 Change-Id: I1a7cea35830bb786b67aee235337f89c62a4b69f Signed-off-by: Genaro Saucedo Tejada <genaro.saucedo.tejada@intel.com>
2016-08-05doc: Add file system documentationRamesh Thomas
Adds documentation of file system APIs Jira: ZEP-643 Change-Id: Ieac14a3dcf4913aeba6da2d3dc718eaa09b6cd88 Signed-off-by: Ramesh Thomas <ramesh.thomas@intel.com>
2016-08-05Revert "microkernel: remove deprecated task IRQs"Andrew Boie
This reverts commit d73a9bb9c6feb25886cecf56d08ec4f3a133855b. The patch was intended for 1.6.0 release. Change-Id: Id42058b746a3d2a54e4b1a2983eb58bd10b1ed40 Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
2016-08-05doc: Clarified Mac OS X set up instructionsGenaro Saucedo Tejada
Mac OS X set up instructions were missing some important details that prevent a new user to set up Zephyr development environment on a not yet configured system. JIRA: ZEP-616 Change-Id: I0890ec5364a0ce21e38ba4101d285fc8e46a6bd8 Signed-off-by: Genaro Saucedo Tejada <genaro.saucedo.tejada@intel.com>
2016-08-05microkernel: remove deprecated task IRQsAndrew Boie
Change-Id: I06393c8ee0e864105cd0183c92e453638679fe81 Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
2016-08-04doc: add ncurses to linux dev host setup docDavid B. Kinder
update /doc/getting_started/installation_linux.rst with ncurses package for both Ubuntu and Fedora systems Jira: zep-478 Change-Id: Icd4ba5c2151e96330005e3e31f5ea50b437e4f18 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-22 15:01:03 +0000