RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

sys/include: fix typos

Browse Source
This commit is contained in:
Kaspar Schleiser 2019-10-23 21:16:22 +02:00
parent ec8a4ba3c2
commit 61db4d9724
39 changed files with 55 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sys/include/analog_util.h
View File

@ -46,7 +46,7 @@ int32_t adc_util_map(int sample, adc_res_t res, int32_t min, int32_t max);
/**
* @brief Map a sampled ADC value to a given range (using floating point
* arithmetics)
* arithmetic)
*
* @see adc_util_map
*

4
sys/include/auto_init.h
View File

@ -37,7 +37,7 @@
* automatically using the `auto_init` module.
* To do so, each driver implementation must provide default initialization
* parameters in the `DRIVER_params.h` file.
* These parameters can be overriden from the application code in several ways
* These parameters can be overridden from the application code in several ways
* (examples with the @ref drivers_bmp180 oversampling parameter
* `BMP180_PARAM_OVERSAMPLING`):
*
@ -100,7 +100,7 @@ extern "C" {
* @brief Initializes all high level modules that do not require parameters for
* initialization or uses default values.
*
* This function gets called - if not explicitely disabled - by @ref
* This function gets called - if not explicitly disabled - by @ref
* kernel_init right before jumping into @e main.
*/
void auto_init(void);

2
sys/include/can/isotp.h
View File

@ -195,7 +195,7 @@ int isotp_bind(struct isotp *isotp, can_reg_entry_t *entry, void *arg,
* Unset the filter on the DLL and remove the channel from the list
* of bound channels
*
* @param isotp the channel to relase
* @param isotp the channel to release
*
* @return 0 on success, < 0 on error
*/

2
sys/include/can/raw.h
View File

@ -72,7 +72,7 @@ int raw_can_send(int ifnum, const struct can_frame *frame, kernel_pid_t pid);
* @param[in] ifnum the interface number used to send the frame
* @param[in] handle the handle of the frame to abort,
* it must be the value returned by raw_can_send
* @return 0 on succes
* @return 0 on success
* @return < 0 on error (-ENODEV)
*/
int raw_can_abort(int ifnum, int handle);

2
sys/include/crypto/chacha.h
View File

@ -60,7 +60,7 @@ typedef struct {
* @param[in] nonce IV / nonce to use.
*
* @return `== 0` on success.
* @return `< 0` if an illegal value for @p rounds or @p keylen was suppplied.
* @return `< 0` if an illegal value for @p rounds or @p keylen was supplied.
*/
int chacha_init(chacha_ctx *ctx,
unsigned rounds,

2
sys/include/crypto/ciphers.h
View File

@ -63,7 +63,7 @@ extern "C" {
#define CIPHER_ERR_INVALID_LENGTH -4
#define CIPHER_ERR_ENC_FAILED -5
#define CIPHER_ERR_DEC_FAILED -6
/** Is returned by the cipher_init functions, if the coresponding alogirithm has not been included in the build */
/** Is returned by the cipher_init functions, if the corresponding alogirithm has not been included in the build */
#define CIPHER_ERR_BAD_CONTEXT_SIZE 0
/** Returned by cipher_init upon successful initialization of a cipher. */
#define CIPHER_INIT_SUCCESS 1

2
sys/include/crypto/modes/cbc.h
View File

@ -40,7 +40,7 @@ extern "C" {
*
* @return <0 on error
* @return CIPHER_ERR_INVALID_LENGTH when input_len % BLOCK_SIZE != 0
* @return CIPHER_ERR_ENC_FAILED on internal encrption error
* @return CIPHER_ERR_ENC_FAILED on internal encryption error
* @return otherwise number of input bytes that aren't consumed
*/
int cipher_encrypt_cbc(cipher_t *cipher, uint8_t iv[16], const uint8_t *input,

4
sys/include/crypto/modes/ocb.h
View File

@ -65,7 +65,7 @@ extern "C" {
* @param cipher Already initialized cipher struct
* @param auth_data Additional data to authenticate in MAC
* @param auth_data_len Length of additional data
* @param tag_len Length of the appended tag (at leat 1, at most 16 bytes)
* @param tag_len Length of the appended tag (at least 1, at most 16 bytes)
*
* @param nonce Nonce for the encryption (must be unique)
* @param nonce_len Length of the nonce in bytes (at most 15)
@ -88,7 +88,7 @@ int32_t cipher_encrypt_ocb(cipher_t *cipher, uint8_t *auth_data,
* @param cipher Already initialized cipher struct
* @param auth_data Additional data to authenticate in MAC
* @param auth_data_len Length of additional data
* @param tag_len Length of the appended tag (at leat 1, at most 16 bytes)
* @param tag_len Length of the appended tag (at least 1, at most 16 bytes)
*
* @param nonce Nonce for the encryption (must be unique)
* @param nonce_len Length of the nonce in bytes (at most 15)

4
sys/include/div.h
View File

@ -79,8 +79,8 @@ static inline uint64_t div_u64_by_15625(uint64_t val)
* @brief Integer divide val by 125
*
* This function can be used to convert uint64_t microsecond times (or
* intervals) to miliseconds and store them in uint32_t variables, with up to
* ~50 days worth of miliseconds ((2**32*1000) -1).
* intervals) to milliseconds and store them in uint32_t variables, with up to
* ~50 days worth of milliseconds ((2**32*1000) -1).
* Use e.g., ms = div_u64_by_125(microseconds >> 3)
*
* @pre val <= 536870911999 ((2**32 * 125) -1)

2
sys/include/embUnit/TestResult.h
View File

@ -58,7 +58,7 @@ struct __TestResult {
(TestListner*)listener,\
}
void TestResult_init(TestResult* self,TestListner* listner);
void TestResult_init(TestResult* self,TestListner* listener);
void TestResult_startTest(TestResult* self,Test* test);
void TestResult_endTest(TestResult* self,Test* test);
void TestResult_addFailure(TestResult* self,Test* test,const char* msg,int line,const char* file);

2
sys/include/event/timeout.h
View File

@ -12,7 +12,7 @@
* @ingroup sys_event
* @brief Provides functionality to trigger events after timeout
*
* event_timeout intentionally does't extend event structures in order to
* event_timeout intentionally doesn't extend event structures in order to
* support events that are integrated in larger structs intrusively.
*
* Example:

2
sys/include/fmt.h
View File

@ -381,7 +381,7 @@ uint32_t scn_u32_dec(const char *str, size_t n);
*
* Will convert up to @p n char. Stop at any non-hexadecimal or '\0' character
*
* @param[in] str Pointer to tring to read from
* @param[in] str Pointer to string to read from
* @param[in] n Maximum number of characters to consider
*
* @return converted uint32_t value

2
sys/include/hashes/cmac.h
View File

@ -40,7 +40,7 @@ extern "C" {
typedef struct {
/** AES128 context */
cipher_t aes_ctx;
/** auxiliar array for CMAC calculations **/
/** auxiliary array for CMAC calculations **/
uint8_t X[CMAC_BLOCK_SIZE];
/** current last block **/
uint8_t M_last[CMAC_BLOCK_SIZE];

2
sys/include/net/csma_sender.h
View File

@ -104,7 +104,7 @@ int csma_sender_csma_ca_send(netdev_t *dev, iolist_t *iolist,
const csma_sender_conf_t *conf);
/**
* @brief Sends a 802.15.4 frame when medium is avaiable.
* @brief Sends a 802.15.4 frame when medium is available.
*
* @pre `dev != NULL`
*

2
sys/include/net/fib/table.h
View File

@ -117,7 +117,7 @@ typedef struct {
* This value indicates what is stored in `data` of this table
*/
uint8_t table_type;
/** the maximim number of entries in this FIB table */
/** the maximum number of entries in this FIB table */
size_t size;
/** table access mutex to grant exclusive operations on calls */
mutex_t mtx_access;

2
sys/include/net/gnrc/icmpv6/error.h
View File

@ -85,7 +85,7 @@ void gnrc_icmpv6_error_time_exc_send(uint8_t code,
* multicast
*
* @param[in] code The [code for the message](@ref net_icmpv6_error_param_prob_codes).
* @param[in] ptr Pointer to the errorneous octet in @p orig_pkt.
* @param[in] ptr Pointer to the erroneous octet in @p orig_pkt.
* @param[in] orig_pkt The invoking packet.
*/
void gnrc_icmpv6_error_param_prob_send(uint8_t code, void *ptr,

2
sys/include/net/gnrc/ipv6/ext/frag.h
View File

@ -126,7 +126,7 @@ void gnrc_ipv6_ext_frag_send(gnrc_ipv6_ext_frag_send_t *snd_buf);
* the fragment header in the first snip.
*
* @return The reassembled packet when @p pkt completed the reassembly
* @return NULL, when there are still fragments missing or an error occured
* @return NULL, when there are still fragments missing or an error occurred
* during reassembly
*/
gnrc_pktsnip_t *gnrc_ipv6_ext_frag_reass(gnrc_pktsnip_t *pkt);

2
sys/include/net/gnrc/ipv6/hdr.h
View File

@ -7,7 +7,7 @@
*/
/**
* @defgroup net_gnrc_ipv6_hdr IPv6 header defintions
* @defgroup net_gnrc_ipv6_hdr IPv6 header definitions
* @ingroup net_gnrc_ipv6
* @{
*

2
sys/include/net/gnrc/ipv6/nib/pl.h
View File

@ -13,7 +13,7 @@
* @{
*
* @file
* @brief Prefix list defintions
* @brief Prefix list definitions
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
*/

2
sys/include/net/gnrc/lwmac/timeout.h
View File

@ -90,7 +90,7 @@ void gnrc_lwmac_reset_timeouts(gnrc_netif_t *netif);
/**
* @brief Make a specific LWMAC timeout expired.
*
* @param[in,out] timeout LWMAC tiemout
* @param[in,out] timeout LWMAC timeout
*/
void gnrc_lwmac_timeout_make_expire(gnrc_lwmac_timeout_t *timeout);

4
sys/include/net/gnrc/lwmac/types.h
View File

@ -167,7 +167,7 @@ typedef enum {
* @brief LWMAC timeout types
*/
typedef enum {
GNRC_LWMAC_TIMEOUT_DISABLED, /**< Timeout is diabled */
GNRC_LWMAC_TIMEOUT_DISABLED, /**< Timeout is disabled */
GNRC_LWMAC_TIMEOUT_WR, /**< WR timeout, waiting WA */
GNRC_LWMAC_TIMEOUT_NO_RESPONSE, /**< Maximum WR duration timeout awaiting WA */
GNRC_LWMAC_TIMEOUT_DATA, /**< Timeout awaiting data packet from receiver */
@ -193,7 +193,7 @@ typedef struct {
typedef struct lwmac {
gnrc_lwmac_state_t state; /**< Internal state of MAC layer */
uint32_t last_wakeup; /**< Used to calculate wakeup times */
uint8_t lwmac_info; /**< LWMAC's internal informations (flags) */
uint8_t lwmac_info; /**< LWMAC's internal information (flags) */
gnrc_lwmac_timeout_t timeouts[GNRC_LWMAC_TIMEOUT_COUNT]; /**< Store timeouts used for protocol */
#if (GNRC_MAC_ENABLE_DUTYCYCLE_RECORD == 1)

2
sys/include/net/gnrc/netif.h
View File

@ -278,7 +278,7 @@ gnrc_netif_t *gnrc_netif_iter(const gnrc_netif_t *prev);
gnrc_netif_t *gnrc_netif_get_by_pid(kernel_pid_t pid);
/**
* @brief Gets the (unicast on anycast) IPv6 addresss of an interface (if IPv6
* @brief Gets the (unicast on anycast) IPv6 address of an interface (if IPv6
* is supported)
*
* @pre `netif != NULL`

2
sys/include/net/gnrc/netif/ipv6.h
View File

@ -11,7 +11,7 @@
* @{
*
* @file
* @brief IPv6 defintions for @ref net_gnrc_netif
* @brief IPv6 definitions for @ref net_gnrc_netif
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
*/

2
sys/include/net/gnrc/netreg.h
View File

@ -40,7 +40,7 @@ extern "C" {
/**
* @brief The type of the netreg entry.
*
* Different types are availalbe dependent on the used modules.
* Different types are available dependent on the used modules.
*/
typedef enum {
/**

2
sys/include/net/gnrc/rpl.h
View File

@ -522,7 +522,7 @@ gnrc_rpl_instance_t *gnrc_rpl_root_init(uint8_t instance_id, ipv6_addr_t *dodag_
void gnrc_rpl_send_DIO(gnrc_rpl_instance_t *instance, ipv6_addr_t *destination);
/**
* @brief Send a DIS of the @p instace to the @p destination.
* @brief Send a DIS of the @p instance to the @p destination.
*
* @param[in] instance Pointer to the RPL instance, optional.
* @param[in] destination IPv6 address of the destination.

2
sys/include/net/gnrc/rpl/p2p.h
View File

@ -126,7 +126,7 @@ extern const uint8_t gnrc_rpl_p2p_lifetime_lookup[4];
* @param[in] instance_id Id of the instance
* @param[in] dodag_id Id of the DODAG
* @param[in] target Target of the P2P-RPL routes discovery
* @param[in] gen_inst_id Flag indicating whether to generate a local isntance id.
* @param[in] gen_inst_id Flag indicating whether to generate a local instance id.
* If true, @p instance_id will be ignored
*
* @return Pointer to the new Instance, on success.

10
sys/include/net/gnrc/tcp.h
View File

@ -78,7 +78,7 @@ void gnrc_tcp_tcb_init(gnrc_tcp_tcb_t *tcb);
* -ENOMEM if the receive buffer for the TCB could not be allocated.
* -EADDRINUSE if @p local_port is already used by another connection.
* -ETIMEDOUT if the connection could not be opened.
* -ECONNREFUSED if the connection was resetted by the peer.
* -ECONNREFUSED if the connection was reset by the peer.
*/
int gnrc_tcp_open_active(gnrc_tcp_tcb_t *tcb, uint8_t address_family,
char *target_addr, uint16_t target_port,
@ -100,7 +100,7 @@ int gnrc_tcp_open_active(gnrc_tcp_tcb_t *tcb, uint8_t address_family,
* If local_addr == NULL, address_family is ignored.
* @param[in] local_addr If not NULL the connection is bound to @p local_addr.
* If NULL a connection request to all local ip
* addresses is valied.
* addresses is valid.
* @param[in] local_port Port number to listen on.
*
* @returns 0 on success.
@ -132,7 +132,7 @@ int gnrc_tcp_open_passive(gnrc_tcp_tcb_t *tcb, uint8_t address_family,
*
* @returns The number of successfully transmitted bytes.
* -ENOTCONN if connection is not established.
* -ECONNRESET if connection was resetted by the peer.
* -ECONNRESET if connection was reset by the peer.
* -ECONNABORTED if the connection was aborted.
* -ETIMEDOUT if @p user_timeout_duration_us expired.
*/
@ -163,7 +163,7 @@ ssize_t gnrc_tcp_send(gnrc_tcp_tcb_t *tcb, const void *data, const size_t len,
* 0, if the connection is closing and no further data can be read.
* -ENOTCONN if connection is not established.
* -EAGAIN if user_timeout_duration_us is zero and no data is available.
* -ECONNRESET if connection was resetted by the peer.
* -ECONNRESET if connection was reset by the peer.
* -ECONNABORTED if the connection was aborted.
* -ETIMEDOUT if @p user_timeout_duration_us expired.
*/
@ -196,7 +196,7 @@ void gnrc_tcp_abort(gnrc_tcp_tcb_t *tcb);
* @param[in] hdr Gnrc_pktsnip that contains TCP header.
* @param[in] pseudo_hdr Gnrc_pktsnip that contains network layer header.
*
* @returns 0 on succees.
* @returns 0 on success.
* -EFAULT if @p hdr or pseudo_hdr were NULL
* -EBADMSG if @p hdr is not of type GNRC_NETTYPE_TCP
* -ENOENT if @p pseudo_hdr protocol is unsupported.

2
sys/include/net/gnrc/tcp/config.h
View File

@ -41,7 +41,7 @@ extern "C" {
#endif
/**
* @brief Maximum Segement Size (MSS).
* @brief Maximum Segment Size (MSS).
*/
#ifndef GNRC_TCP_MSS
#ifdef MODULE_GNRC_IPV6

2
sys/include/net/ieee802154.h
View File

@ -97,7 +97,7 @@ extern "C" {
#define IEEE802154_FRAME_LEN_MAX (127U) /**< maximum frame length */
/**
* @brief Special address defintions
* @brief Special address definitions
* @{
*/
/**

10
sys/include/net/ipv6/addr.h
View File

@ -202,7 +202,7 @@ typedef union {
* </a>
*/
/**
* @brief The address is transient, i.e. not well-known, permanantly
* @brief The address is transient, i.e. not well-known, permanently
* assigned address by IANA.
*/
#define IPV6_ADDR_MCAST_FLAG_TRANSIENT (0x01)
@ -746,16 +746,16 @@ char *ipv6_addr_split_str(char *addr_str, char separator);
/**
* @brief split IPv6 address string representation
*
* @note Will change @p seperator position in @p addr_str to '\0'
* @note Will change @p separator position in @p addr_str to '\0'
*
* @param[in,out] addr_str Address to split
* @param[in] seperator Seperator char to use
* @param[in] separator Separator char to use
* @param[in] _default Default value
*
* @return atoi(string after split)
* @return @p _default if no string after @p seperator
* @return @p _default if no string after @p separator
*/
int ipv6_addr_split_int(char *addr_str, char seperator, int _default);
int ipv6_addr_split_int(char *addr_str, char separator, int _default);
/**
* @brief split IPv6 prefix string representation

4
sys/include/net/sixlowpan.h
View File

@ -13,7 +13,7 @@
* @{
*
* @file
* @brief 6LoWPAN dispatch type and helper function definitons.
* @brief 6LoWPAN dispatch type and helper function definitions.
*
* @author Martine Lenders <mlenders@inf.fu-berlin.de>
*/
@ -316,7 +316,7 @@ static inline uint16_t sixlowpan_frag_offset(sixlowpan_frag_n_t *hdr)
#define SIXLOWPAN_IPHC_HDR_LEN (2)
/**
* @brief 6LoWPAN context idendifier extension header length
* @brief 6LoWPAN context identifier extension header length
*/
#define SIXLOWPAN_IPHC_CID_EXT_LEN (1)

2
sys/include/net/tcp.h
View File

@ -49,7 +49,7 @@ extern "C" {
* @brief TCP option "length"-field values.
* @{
*/
#define TCP_OPTION_LENGTH_MIN (2U) /**< Mimimum amount of bytes needed for an option with a length field */
#define TCP_OPTION_LENGTH_MIN (2U) /**< Minimum amount of bytes needed for an option with a length field */
#define TCP_OPTION_LENGTH_MSS (0x04) /**< MSS Option Size always 4 */
/** @} */

2
sys/include/phydat.h
View File

@ -124,7 +124,7 @@ enum {
/**
* @brief Generic data structure for expressing physical values
*
* Physical data is expressed in a 3-dimensional touple of values. In addition
* Physical data is expressed in a 3-dimensional tuple of values. In addition
* to the data fields, this struct contains further the (physical) unit and the
* scale factor of the data. The unit is expressed as constant. The scale factor
* is expressed as power of 10 (10^factor).

4
sys/include/puf_sram.h
View File

@ -61,7 +61,7 @@ extern uint32_t puf_sram_state;
calls @p puf_sram_generate
*
* @param[in] ram pointer to SRAM memory
* @param[in] len length of the memroy to consider
* @param[in] len length of the memory to consider
*
*/
void puf_sram_init(const uint8_t *ram, size_t len);
@ -71,7 +71,7 @@ void puf_sram_init(const uint8_t *ram, size_t len);
* to the global variable @p puf_sram_seed and returns the value
*
* @param[in] ram pointer to SRAM memory
* @param[in] len length of the memroy to consider
* @param[in] len length of the memory to consider
*/
void puf_sram_generate(const uint8_t *ram, size_t len);

2
sys/include/suit/v4/suit.h
View File

@ -266,7 +266,7 @@ int suit_cbor_subparse(nanocbor_value_t *bseq, nanocbor_value_t *it);
* @param[in] offset offset to write to on flash
* @param[in] buf bytes to write
* @param[in] len length of bytes to write
* @param[in] more whether more data is comming
* @param[in] more whether more data is coming
*
* @return 0 on success
* @return <0 on error

2
sys/include/tm.h
View File

@ -77,7 +77,7 @@ int tm_doomsday(int year) CONST;
/**
* @brief Calculates the day of the year and the weekday of a given date.
* @details Illegal dates are not catched.
* @details Illegal dates are not caught.
* @param[in] year The year. Probably should be ≥ 1582, but needs to be ≥ 1.
* @param[in] mon The month, TM_MON_JAN to TM_MON_DEC.
* @param[in] mday The day in the month, 1 to 31.

6
sys/include/universal_address.h
View File

@ -101,7 +101,7 @@ void universal_address_rem(universal_address_container_t *entry);
* this value is overwritten with the actual size required
*
* @return addr if the address is copied to the addr destination
* @return NULL if the size is unsufficient for copy
* @return NULL if the size is insufficient for copy
*/
uint8_t* universal_address_get_address(universal_address_container_t *entry,
uint8_t *addr, size_t *addr_size);
@ -123,7 +123,7 @@ uint8_t* universal_address_get_address(universal_address_container_t *entry,
* (trailing '0's in @p entry)
* @return UNIVERSAL_ADDRESS_IS_ALL_ZERO_ADDRESS if the entry address is all `0`s
* and considered as default route
* @return -ENOENT if the given adresses do not match
* @return -ENOENT if the given addresses do not match
*/
int universal_address_compare(universal_address_container_t *entry,
uint8_t *addr, size_t *addr_size_in_bits);
@ -145,7 +145,7 @@ int universal_address_compare(universal_address_container_t *entry,
* @return UNIVERSAL_ADDRESS_EQUAL if the entries are equal
* @return UNIVERSAL_ADDRESS_MATCHING_PREFIX if the entry matches to a certain prefix
* (trailing '0's in @p prefix)
* @return -ENOENT if the given adresses do not match
* @return -ENOENT if the given addresses do not match
*/
int universal_address_compare_prefix(universal_address_container_t *entry,
uint8_t *prefix, size_t prefix_size_in_bits);

2
sys/include/usb/usbus/control.h
View File

@ -35,7 +35,7 @@ typedef struct {
size_t start; /**< Start offset of the current part */
size_t cur; /**< Current position in the message */
size_t len; /**< Length of the full message */
size_t transferred; /**< Number of bytes transferred */
size_t transferred; /**< Number of bytes transferred */
size_t reqlen; /**< Maximum length of the request */
} usbus_control_slicer_t;

2
sys/include/uuid.h
View File

@ -156,7 +156,7 @@ void uuid_to_string(const uuid_t *uuid, char *str);
* @param[out] uuid out UUID
* @param[in] str null-terminated input UUID string, must be UUID_STR_LEN bytes
*
* @return 0 on succes, < 0 if @p str is not valid
* @return 0 on success, < 0 if @p str is not valid
*/
int uuid_from_string(uuid_t *uuid, const char *str);