Added sphynx comments required to link C code comments to rst
documentation, additionally a new rest page with the list of
current system log Kconfig options and an example.
Change-Id: I9d1370b5f0a2fbd858de83befb99f0f4c7024a13
Signed-off-by: Genaro Saucedo Tejada <genaro.saucedo.tejada@intel.com>
JIRA: ZEP-153
This is a sample static testcase (that needs no hardware target) that
will build the documentation and ensure it builds without issues.
Change-Id: I7174205522be9aead350e67b1672b8e976cb9191
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
These are files and directories generated when running automated
real-hardware testcases.
Change-Id: Ia8474835e435b8824a0b5f2d7db6bbf619634154
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
For automation to detect this is the right test case being executed,
print the RUNID if defined
This TC doesn't use TC_*() macros, so we need to invoke it manually.
Change-Id: I6f7417621d649a59412bb92d8b665130757d926a
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
This is a helper to print a token passed form the compilation
environment.
Further documentation and rationale in the code.
Change-Id: I8d5e6b2246ba5c4f09b78532b3c600891f94bb63
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Move to use :option:`CONFIG_XYZ` vs :option:`XYZ` to generate propert
links and avoid warnings about unexistant targets.
Change-Id: I4b46041f25e538462b123ccc8337f733033cc0e7
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Config options KERNEL_EVENT_{INTERRUPT, CONTEXT, SLEEP} don't exist
any more, removed.
Move to use :option:`CONFIG_XYZ` vs :option:`XYZ` to generate propert
links and avoid warnings about unexistant targets.
Change-Id: Ibafa155f474a05329a8cac7bff5c55800d9f31a4
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
No code uses it and it being undefined anywhere generates a
documentation warning.
Change-Id: I09de2e58edf82e7fb9780a5dea98a282502436b6
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
This creates proper links and removes undefined link warnings.
Change-Id: Id8c4cc4279114cab05ed8ad3f7da24f7ce673e8d
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
This allows us to cross ref from code with :option:`CONFIG_XYZ`
generating a useful link and avoiding an 'undefined target` warning.
Hyperlink using :option: instead of :ref:.
Change-Id: I6cc0daec012dfcca504faa47d591885e69c8e521
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
When we are specifying some kind of option that we are not
documenting, we shall not use :option:`xx` as it will generate a
warning. Thus, use ``xx`` in its place (or *xx* in others) as needed.
Not all converted, as others make sense to move from xx to CONFIG_xx,
which will be handled separately.
Change-Id: I98d5e70da471184f99bb491b1fa1a3b7086019d2
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Pass -q to sphinx-build so it only prints what is wrong, not a huge
list of progress information that in most cases is not necessary.
Note that this can be overriden from the environment.
Change-Id: I8735e7ad9a2998734d4e9dda9b3e826ce07b5527
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
- :option:`XYZ` can only be used if there is an .. option: XYZ
definititon somewhere; replaced with a more generic monospace
``XYZ``.
- Fixed broken link to 'Creating and Configuring an MDEF File for a
Microkernel Application'.
Change-Id: I2b1e862415035500c00dcce0a33d14bac4126044
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Four code snippets fail to be properly recognized by the code
highlighter; the makefile snippets seem to be because of the $
character (and I have found a way to escape it out). The C code, I
haven't been able to find out why.
Killed the warning by setting the code-block style to 'none' on all of
them. It is not the best sollution, but it beats a polluted build
process.
Change-Id: I8fa7d327354a93bacad40e25596c9dbaf9ea1e92
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Files had been changed without the offsets being updated, so it was
generating warnings.
Change-Id: I5c7756f396cf607470da1ce6c5807e5a343491d2
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Add missing '*/', rename <entity> to ENTITY and fix indentation so the
formatting engine recognizes the example code as C code.
Change-Id: Iff1b5c0cef5bb635ba1b39f507ff657e9ab4c338
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
To fix, insert the synchronous_calls.rst file inside drivers.rst; they
are both small enough. Plus, none was calling that link anyway.
Change-Id: Iba2027d143cb29497431cb47dfbcf0435087f1ae
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Warnings about duplicate label (_about_zephyr) crept up because of the
way the about_zephyr document was included in the index. This is a
short document, makes sense to have it as part of the index.rst; it
removes clutter from the directory as well as the warning.
Change-Id: Ifdc3a93fb4316be4aef685257d14749769443b41
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
A warning was generated for the TOC entry "About Zephyr", which was
missing; replaced with a link to said section (to reduce clutter in
the document).
Change-Id: I1f879bc21bad8ec857781208ad9e31079015292a
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
This removes warning about duplicate symbol (of _coding_style, due to
the inclusion) plus also a very short file which can be very well
inside conventions.rst.
Change-Id: I7b8467a0a845225a4fe4356f012f60ab0ea202aa
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
It was too short a file, it was causing duplicate link warnings
(_error_code_conventions, due to the inclusion, which wasn't being
used anyway).
This removes the littering of small files and removes warnings from
the documentation compile.
Change-Id: Ic6f225a63d875d77bd2e93b2712baabea2eb0141
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Files that are included directly into other files are not referenced
in TOC trees. Quiet warning by tagging them :orphan:
Change-Id: I3a975420ce366ca155e8c0158dcd0fb7c094a4a0
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Add a blank line in most places is the fix needed, to have the
formatting engine recognize it properly.
Change-Id: Iccaa0e51146b1e2c138e89ab1dd0067fc1409e4d
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
Seem embedding a `code-block` in a `note` section is not working that
well.
Change-Id: I6a0ad0b5a17b2fc1cb9968a85dc794c53a1e27ac
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
The "IDT Security" section was removed since the IDT is now always
in a read-only region; dynamic IRQs have been deprecated and will
be removed from the kernel.
Change-Id: Idbb7ff987bbb4f777b524d87690485d34f372d43
Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
D2000 is shipped with no ROM, advise on how to install one.
Change-Id: I848bb0b4fa2d6972cc6919d69a11e14dee0ce50c
Signed-off-by: Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
At the moment libc gets linked, all unused functions get
stripped and the libqmsi gets linked but __assert_func is not
available.
Change-Id: I7fc2f8b9136f858023b3e983575869a2206ba9ce
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This patch while it fixes a few bugs, introduces other issues, espcially
when building on windows.
This reverts commit ae327c60c9.
Change-Id: I1ffcd6c88d17f5bd6a66df28d99d2d27c0683930
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
After last refactor L2CAP channel context is type of struct
bt_l2cap_le_chan. This fix not being able to use Security Manager.
Change-Id: I6e54a1ab1bc3c48f856b07cb45278e3b8b23b122
Signed-off-by: Szymon Janc <ext.szymon.janc@tieto.com>
This removes the section explaining how to test the IPSP from the general
README moving it ipsp specific README which can be expanded to include
other specific details related to 6LoWPAN, etc.
Change-Id: I80210cacb6b0042b3b0dc570dbdf7d38f92b3031
Signed-off-by: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
The net_buf API ensures that the frags pointer gets initialized
properly. Using nano_fifo_get could mean that buf->frags is something
else than NULL if there was more than one item in the FIFO.
Change-Id: If65e85a7cbe82f562307dc781d48110c3be0472b
Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
This is the only safe way, especially when doing the call from a task.
Change-Id: Ic50b73e04c4b831ac481dd56596f9d36cf0e2ccc
Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
Introduce the family of nano_fifo_put_list and nano_fifo_put_slist APIs,
which allow queuing a list of elements on a nanokernel fifo in one
shot. When called from an ISR or a fiber, the behaviour is not really
different than calling nano_fifo_put for each element to enqueue.
However, when called from a task, it allows the task to enqueue the full
list without yielding to fibers that were waiting on the fifo.
All fibers currently waiting on the fifo will be awakened and given an
element from the list in their order of priority. When some elements are
not matched with a receiver, they are queued normally.
There are two ways of passing a list: with either an ad-hoc queue, by
passing the head and the tail elements, or with a sys_slist_t object.
For the latter, the object must be reinitialized afterwards.
Change-Id: I6ac077f556dc39995191e9149c4a047a3433826f
Signed-off-by: Benjamin Walsh <benjamin.walsh@windriver.com>
Now that buffers can contain fragments we should always use the
net_buf APIs to read/write FIFOs and never the nano_fifo APIs
directly.
Change-Id: I203af43e887145a1b14f33a3729ef721fbd46469
Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
Remove unnecessary bt_l2cap_chan or bt_l2cap_le_chan stack variables
from the code.
Change-Id: Icb306f075d90b67e00155696f8e25f58b89821b2
Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
Refactors L2CAP core data structures and modifies functions that uses them.
Now we can have separate L2CAP feature channel objects for LE and BR/EDR
transport. This's also a ground for make L2CAP CoC API to be common
for both transports.
Change-Id: Ic1197b0e3c4f505764b23fb9c7eb27123a44a675
Signed-off-by: Arkadiusz Lichwa <arkadiusz.lichwa@tieto.com>
The reject command can contain optional data that depends on reject
reason.
Change-Id: I3c1967f39f52a798a720c700c9d12c2877c837dd
Signed-off-by: Arkadiusz Lichwa <arkadiusz.lichwa@tieto.com>
The current documentation points to MyNewt 0.9 which doesn't have the
necessary fix, so revert the workaround until the next release of
MyNewt is out. A minor change to the original patch is that we also
have a delay in prng_init() which seems to be needed since this is now
called earlier during the HCI init sequence.
This reverts commit d75acb44c3.
Change-Id: Ic4919e01bddbfaca477825c3f7fdcb549c8d10ec
Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
Currently CONFIG_BLUETOOTH_PRIVACY is defined as the ability to
generate RPAs, and it depends on CONFIG_BLUETOOTH_SMP. NRPA usage
however may be desirable even without these features (e.g. a
broadcaster-only device). Furthermore, if we are using RPA based
privacy we should be using that instead of NRPA even when doing
non-connectable advertising.
This patch leaves out the option of advertising with the Identity
Address when non-connectable, however if we get a use case for that we
could consider adding a BT_LE_ADV_OPT_ID_ADDR to force using it.
Change-Id: I0502323aec15eefad1a729c393c707108d4cf758
Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
Genaro Saucedo Tejada