| /nrf52832-nimble/rt-thread/documentation/ |
| H A D | Doxyfile | 3 # This file describes the settings to be used by the documentation system
6 # All text after a hash (#) is considered a comment and will be ignored
9 # For lists items can also be appended using:
11 # Values that contain spaces should be placed between quotes (" ")
31 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
32 # This could be handy for archiving the generated documentation or
51 # base path where the generated documentation will be put.
52 # If a relative path is entered, it will be relative to the location
53 # where doxygen was started. If left blank the current directory will be used.
60 # Enabling this option can be useful when feeding doxygen a huge amount of
[all …]
|
| H A D | coding_style_en.txt | 13 have descriptive names. For example, the port of a chip should be composed of
36 of the file name should be connected by "_".
41 In every header file, there should be copyright information and Change Log
49 * The license and distribution terms for this file may be
71 Braces should have their own lines and the members should be defines with
74 The names of type defines such like structure types should be the structure name
80 In order to be easily referenced, the types of objects in kernel is pointer. For
97 upper application should be declared in header files. If the function don't have
98 parameters, it should be declared as void:
105 Please use English to comment. There shouldn't be too much comments and the
[all …]
|
| /nrf52832-nimble/rt-thread/components/dfs/filesystems/jffs2/cyg/compress/include/ |
| H A D | zlib.h | 7 warranty. In no event will the authors be held liable for any damages
14 1. The origin of this software must not be misrepresented; you must not
16 in a product, an acknowledgment in the product documentation would be
18 2. Altered source versions must be plainly marked as such, and must not be
20 3. This notice may not be removed or altered from any source distribution.
47 (deflation) but other algorithms will be added later and will have the same
50 Compression can be done in a single step if the buffers are large
51 enough (for example if an input file is mmap'ed), or can be done by
67 The zlib format was designed to be compact and fast for use in memory
87 Bytef *next_out; /* next output byte should be put there */
[all …]
|
| /nrf52832-nimble/rt-thread/components/dfs/filesystems/jffs2/cyg/compress/ |
| H A D | zlib.h | 7 warranty. In no event will the authors be held liable for any damages
14 1. The origin of this software must not be misrepresented; you must not
16 in a product, an acknowledgment in the product documentation would be
18 2. Altered source versions must be plainly marked as such, and must not be
20 3. This notice may not be removed or altered from any source distribution.
47 (deflation) but other algorithms will be added later and will have the same
50 Compression can be done in a single step if the buffers are large
51 enough (for example if an input file is mmap'ed), or can be done by
67 The zlib format was designed to be compact and fast for use in memory
87 Bytef *next_out; /* next output byte should be put there */
[all …]
|
| /nrf52832-nimble/rt-thread/components/net/lwip-2.0.2/doc/ |
| H A D | sys_arch.txt | 14 lwIP functionality, multiple threads support can be implemented in the
16 functionality. Timer scheduling is implemented in lwIP, but can be implemented
24 Semaphores can be either counting or binary - lwIP works with both
25 kinds. Mailboxes should be implemented as a queue which allows multiple messages
26 to be posted (implementing as a rendez-vous point where only one message can be
37 allows both using pointers or actual OS structures to be used. This way, memory
38 required for such types can be either allocated in place (globally or on the
41 The following functions must be implemented by the sys_arch:
50 points to (which can be both a pointer or the actual OS structure).
53 If the semaphore has been created, ERR_OK should be returned. Returning any
[all …]
|
| H A D | rawapi.txt | 12 to be used without an operating system that implements zero-copy send and
28 in the specification of this API, there might be incompatibilities
37 environment, raw API functions MUST only be called from the core thread
43 As such, the list of functions that may be called from
54 Additionaly, memory (de-)allocation functions may be
62 not be shared among multiple threads without proper locking.
66 pbuf_free() may also be called from another thread or
68 be called from an ISR: otherwise, the HEAP is only
86 is the preferred way of writing applications that should be small in
89 All APIs can be used simultaneously by different application
[all …]
|
| /nrf52832-nimble/rt-thread/components/CMSIS/RTOS/ |
| H A D | cmsis_os.h | 39 Definitions that are marked with <b>CAN BE CHANGED</b> can be adapted towards the needs of the actu…
40 These definitions can be specific to the underlying RTOS kernel.
42 Definitions that are marked with <b>MUST REMAIN UNCHANGED</b> cannot be altered. Otherwise the CMSI…
43 compliant to the standard. Note that some functions are optional and need not to be provided by eve…
48 The following CMSIS-RTOS functions can be called from threads and interrupt service routines (ISR):
55 Functions that cannot be called from an ISR are verifying the interrupt status and return in case t…
56 from an ISR context the status code \b osErrorISR. In some implementations this condition might be …
81 …file, the objects are defined as external symbols. A single consistent header file can therefore be
90 #define osObjectExternal // Objects will be defined as external symbols
104 /// \note CAN BE CHANGED: \b osCMSIS_KERNEL identifies the underlaying RTOS kernel and version numb…
[all …]
|
| /nrf52832-nimble/rt-thread/components/net/uip/doc/ |
| H A D | uip-doc.txt | 12 the order of a few kilobytes and RAM usage can be configured to be as
15 uIP can be found at the uIP web page: http://www.sics.se/~adam/uip/
35 with full TCP/IP support will be first-class network citizens, thus
39 resources both in terms of code size and memory usage to be useful in
58 peer-to-peer services and protocols. uIP is designed to be RFC
70 protocols and upper layer protocols will be referred to as "the
72 or firmware and will be referred to as "the network device" that are
86 can be passed to higher layers.
94 The RFC1122 requirements can be divided into two categories; those
97 example of the first kind is "A TCP MUST be able to receive a TCP
[all …]
|
| /nrf52832-nimble/rt-thread/components/net/lwip-1.4.1/doc/ |
| H A D | rawapi.txt | 22 in the specification of this API, there might be incompatibilities
30 (also known as the "tcpip_thread"). The raw API may only be used from
34 As such, the list of functions that may be called from
44 Additionaly, memory (de-)allocation functions may be
51 pbuf_free() may also be called from another thread or
53 be called from an ISR: otherwise, the HEAP is only
71 is the preferred way of writing applications that should be small in
74 Both APIs can be used simultaneously by different application
83 argument. Also, in order to be able to keep program specific state,
91 Specifies the program specific state that should be passed to all
[all …]
|
| H A D | sys_arch.txt | 13 lwIP functionality, multiple threads support can be implemented in the
24 Semaphores can be either counting or binary - lwIP works with both
25 kinds. Mailboxes are used for message passing and can be implemented
26 either as a queue which allows multiple messages to be posted to a
27 mailbox, or as a rendez-vous point where only one message can be
29 be more efficient. A message in a mailbox is just a pointer, nothing
38 allows both using pointers or actual OS structures to be used. This way, memory
39 required for such types can be either allocated in place (globally or on the
42 The following functions must be implemented by the sys_arch:
51 points to (which can be both a pointer or the actual OS structure).
[all …]
|
| /nrf52832-nimble/rt-thread/components/net/uip/uip/ |
| H A D | uipopt.h | 7 * should be tweaked to match each specific project. The uIP
8 * distribution contains a documented example "uipopt.h" that can be
12 * be changed, but rather the per-project uip-conf.h file.
38 * 3. The name of the author may not be used to endorse or promote
45 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
78 * These configuration options can be used for setting the IP address
83 * if uIP should be run over Ethernet.
85 * All of these should be changed to suit your project.
93 * uip_setdraddr() and uip_setnetmask() should be used instead.
105 * packet will be used for setting the hosts IP address.
[all …]
|
| /nrf52832-nimble/rt-thread/components/net/lwip-2.1.0/doc/doxygen/ |
| H A D | lwip.Doxyfile | 3 # This file describes the settings to be used by the documentation system
9 # All text after a single hash (#) is considered a comment and will be ignored.
12 # For lists, items can also be appended using:
14 # Values that contain spaces should be placed between quotes (\" \").
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38 # could be handy for archiving the generated documentation or if some version
57 # into which the generated documentation will be written. If a relative path is
58 # entered, it will be relative to the location where doxygen was started. If
59 # left blank the current directory will be used.
66 # option can be useful when feeding doxygen a huge amount of source files, where
[all …]
|
| H A D | lwip.Doxyfile.cmake.in | 3 # This file describes the settings to be used by the documentation system
9 # All text after a single hash (#) is considered a comment and will be ignored.
12 # For lists, items can also be appended using:
14 # Values that contain spaces should be placed between quotes (\" \").
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38 # could be handy for archiving the generated documentation or if some version
57 # into which the generated documentation will be written. If a relative path is
58 # entered, it will be relative to the location where doxygen was started. If
59 # left blank the current directory will be used.
66 # option can be useful when feeding doxygen a huge amount of source files, where
[all …]
|
| /nrf52832-nimble/rt-thread/components/net/lwip-2.0.2/doc/doxygen/ |
| H A D | lwip.Doxyfile | 3 # This file describes the settings to be used by the documentation system
9 # All text after a single hash (#) is considered a comment and will be ignored.
12 # For lists, items can also be appended using:
14 # Values that contain spaces should be placed between quotes (\" \").
37 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38 # could be handy for archiving the generated documentation or if some version
57 # into which the generated documentation will be written. If a relative path is
58 # entered, it will be relative to the location where doxygen was started. If
59 # left blank the current directory will be used.
66 # option can be useful when feeding doxygen a huge amount of source files, where
[all …]
|
| /nrf52832-nimble/packages/NimBLE-latest/docs/ |
| H A D | doxygen.xml | 21 # This file describes the settings to be used by the documentation system
27 # All text after a single hash (#) is considered a comment and will be ignored.
30 # For lists, items can also be appended using:
32 # Values that contain spaces should be placed between quotes (\" \").
55 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
56 # could be handy for archiving the generated documentation or if some version
75 # into which the generated documentation will be written. If a relative path is
76 # entered, it will be relative to the location where doxygen was started. If
77 # left blank the current directory will be used.
84 # option can be useful when feeding doxygen a huge amount of source files, where
[all …]
|
| /nrf52832-nimble/rt-thread/components/net/lwip-2.1.0/src/include/lwip/ |
| H A D | sys.h | 18 * 3. The name of the author may not be used to endorse or promote products
24 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
100 /* Function prototypes for functions to be implemented by platform ports
106 should be used instead */
126 * Note that mutexes are expected to not be taken recursively by the lwIP code,
129 * points to (which can be both a pointer or the actual OS structure).
130 * If the mutex has been created, ERR_OK should be returned. Returning any
140 * Blocks the thread until the mutex can be grabbed.
161 * When directly using OS structures, implementing this may be more complex.
162 * This may also be a define, in which case the function is not prototyped.
[all …]
|
| /nrf52832-nimble/nordic/nrfx/drivers/include/ |
| H A D | nrfx_pwm.h | 16 * contributors may be used to endorse or promote products derived from this
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
84 * @brief This value can be provided instead of a pin number for any channel
86 * to be connected to a pin.
91 * @brief This value can be added to a pin number to inverse its polarity
136 the peripheral should be stopped.
146 it should be started from the beginning.
159 final value will be played only once). */
160 NRFX_PWM_FLAG_SIGNAL_END_SEQ0 = 0x04, /**< The event handler should be
163 NRFX_PWM_FLAG_SIGNAL_END_SEQ1 = 0x08, /**< The event handler should be
[all …]
|
| H A D | nrfx_usbd.h | 16 * contributors may be used to endorse or promote products derived from this
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
58 * This number would be shared between IN and OUT endpoint.
59 * It may be also assigned totaly to one endpoint.
130 * Enumeration of possible events that may be generated by the driver.
154 * Status codes that may be returned by @ref nrfx_usbd_ep_status_get or, except for
162 … * This error would also be returned when next_transfer function has been defined
169 NRFX_USBD_EP_ABORTED, /**< EP0 transfer can be aborted when new setup comes.
170 * Any other transfer can be aborted by USB reset or driver stopping.
208 * Universal data pointer that can be used for any type of transfer.
[all …]
|
| H A D | nrfx_i2s.h | 16 * contributors may be used to endorse or promote products derived from this
22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
51 * @brief This value can be provided instead of a pin number for the signals
53 * and therefore does not need to be connected to a pin.
111 /**< The application should provide buffers that are to be used in the next
113 * be done before the currently used buffers are completely processed
120 * A data handling function of this type must be specified during initialization
122 * buffers passed to it by the application, and when it needs to be provided
126 * will be invalid after the function returns, hence it cannot be stored
128 * should be copied instead.
[all …]
|
| /nrf52832-nimble/rt-thread/components/drivers/sensors/ |
| H A D | sensor.h | 40 * Handles must be higher than SENSORS_HANDLE_BASE and must be unique.
43 * In this version of the API there can only be 256 handles.
75 * that is, if the device can be used in portrait or landscape, this API
114 * in practice sensors shall be disabled while in suspend mode to
120 * set and supported, the specified sensor must be able to wake-up the SoC and
121 * be able to buffer at least 10 seconds worth of the requested sensor events.
142 * sensor types are specific to an OEM and can't be exposed in the SDK.
148 * These sensor types can't be exposed in the SDK.
155 * Many sensor types are or can be implemented as virtual sensors from
163 * In particular, all sensors must be able to function concurrently.
[all …]
|
| /nrf52832-nimble/rt-thread/tools/kconfig-frontends/docs/ |
| H A D | kconfig-language.txt | 34 Usually, modules have to be recompiled whenever you switch to a new
37 Every line starts with a key word and can be followed by multiple
39 define attributes for this config option. Attributes can be the type of
41 values. A config option can be defined multiple times with the same
64 to the user. Optionally dependencies only for this prompt can be added
71 defined. This means the default can be defined somewhere else or be
76 be overridden by him.
77 Optionally, dependencies only for this default value can be added with
83 Optionally dependencies for this default value can be added with "if".
100 below), reverse dependencies can be used to force a lower limit of
[all …]
|
| /nrf52832-nimble/packages/NimBLE-latest/docs/ble_setup/ |
| H A D | ble_lp_clock.rst | 6 Hz clock, the OS cputime has to be configured accordingly.
10 ``1`` so other packages can be configured if necessary. The next section
20 The following things need to be configured for NimBLE controller to work
23 - OS cputime frequency shall be set to ``32768``
24 - OS cputime timer source shall be set to 32768 Hz clock source
25 - Default 1 MHz clock source can be disabled if not used by application
26 - 32768 Hz clock source shall be enabled
27 - Crystal settling time shall be set to non-zero value (see below)
29 For example, on nRF52 platform timer 5 can be used as source for 32768
30 Hz clock. Also, timer 0 can be disabled since this is the default source
[all …]
|
| /nrf52832-nimble/rt-thread/components/net/freemodbus/modbus/include/ |
| H A D | mbconfig.h | 14 * 3. The name of the author may not be used to endorse or promote products
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
41 * Most modules in the protocol stack are completly optional and can be
43 * and program memory space should be saved.<br>
65 * a configuration option. It should be set to the maximum expected delay
72 * The maximum number of supported Modbus functions must be greater than
77 /*! \brief Number of bytes which should be allocated for the <em>Report Slave ID
86 /*! \brief If the <em>Report Slave ID</em> function should be enabled. */
88 /*! \brief If the <em>Read Input Registers</em> function should be enabled. */
90 /*! \brief If the <em>Read Holding Registers</em> function should be enabled. */
[all …]
|
| /nrf52832-nimble/rt-thread/components/net/uip/doc/html/ |
| H A D | main.html | 19 …The code size is on the order of a few kilobytes and RAM usage can be configured to be as low as a…
20 uIP can be found at the uIP web page: <a href="http://www.sics.se/~adam/uip/">http://www.sics.se/~a…
29 …r even the global Internet. Embedded devices with full TCP/IP support will be first-class network …
30 …ired far too much resources both in terms of code size and memory usage to be useful in small 8 or…
32 …unning distributed peer-to-peer services and protocols. uIP is designed to be RFC compliant in ord…
34 …er protocols will be referred to as "the application". Lower layer protocols are often implemented…
35 …e packet will have to reassemble any fragmented IP packets before they can be passed to higher lay…
37 …be divided into two categories; those that deal with the host to host communication and those that…
38 …re are only very few applications that make use of those features they can be removed without loss…
40 The uIP stack can be run either as a task in a multitasking system, or as the main program in a sin…
[all …]
|
| /nrf52832-nimble/rt-thread/components/net/uip/apps/webclient/ |
| H A D | webclient.h | 25 * 3. The name of the author may not be used to endorse or promote
32 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
79 * This function must be implemented by the module that uses the
96 * This function must be implemented by the module that uses the
105 * This function must be implemented by the module that uses the
115 * This function must be implemented by the module that uses the
124 * This function must be implemented by the module that uses the
147 * server could not be contacted, and the webclient_aborted() callback
152 * closed, the webclient_closed() callback function will be called.
154 * \note If the function is passed a host name, it must already be in
[all …]
|