Skip to content

Commit

Permalink
Fix spelling (#58)
Browse files Browse the repository at this point in the history
* Fix spelling

* Disable markdown-lint-check
  • Loading branch information
rotx-eva authored Jun 26, 2024
1 parent b4a1cb6 commit cd646d9
Show file tree
Hide file tree
Showing 182 changed files with 355 additions and 357 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/linter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,3 @@ jobs:
- name: Install markdown-lint-check
run: npm install -g markdown-link-check

- name: Run markdown-lint-check
run: find . -name \*.md -print0 | xargs -0 -n1 markdown-link-check -a 0 -p -v -r
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ static const attCfg_t periphAttCfg =
15, /* ATT server service discovery connection idle timeout in seconds */
//ty 241, /* desired ATT MTU */
BLE_MAX_MTU_SIZE, /* desired ATT MTU */
ATT_MAX_TRANS_TIMEOUT, /* transcation timeout in seconds */
ATT_MAX_TRANS_TIMEOUT, /* transaction timeout in seconds */
4 /* number of queued prepare writes supported by server */
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ static const attCfg_t assetTagAttCfg =
{
15, /* ATT server service discovery connection idle timeout in seconds */
ASSETTAG_DEFAULT_MTU, /* desired ATT MTU */
ATT_MAX_TRANS_TIMEOUT, /* transcation timeout in seconds */
ATT_MAX_TRANS_TIMEOUT, /* transaction timeout in seconds */
4 /* number of queued prepare writes supported by server */
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ static const attCfg_t cyclingAttCfg =
{
15, /* ATT server service discovery connection idle timeout in seconds */
CYCLING_DEFAULT_MTU, /* desired ATT MTU */
ATT_MAX_TRANS_TIMEOUT, /* transcation timeout in seconds */
ATT_MAX_TRANS_TIMEOUT, /* transaction timeout in seconds */
4 /* number of queued prepare writes supported by server */
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ enum
struct
{
uint16_t hdlList[DM_CONN_MAX][APP_DB_HDL_LIST_LEN]; /*! Cached handle list */
wsfHandlerId_t handlerId; /*! WSF hander ID */
wsfHandlerId_t handlerId; /*! WSF handler ID */
bool_t scanning; /*! TRUE if scanning */
bool_t autoConnect; /*! TRUE if auto-connecting */
uint8_t discState[DM_CONN_MAX]; /*! Service discovery state */
Expand Down Expand Up @@ -194,7 +194,7 @@ static const attCfg_t datcAttCfg =
#else
23, /* desired ATT MTU */
#endif /* WDXC_INCLUDED */
ATT_MAX_TRANS_TIMEOUT, /* transcation timeout in seconds */
ATT_MAX_TRANS_TIMEOUT, /* transaction timeout in seconds */
4 /* number of queued prepare writes supported by server */
};

Expand Down Expand Up @@ -592,7 +592,7 @@ static void datcPrivAddDevToResListInd(dmEvt_t *pMsg)
/* Check if in the process of restoring the Device List from NV */
if (datcCb.restoringResList)
{
/* Retore next device to resolving list in Controller. */
/* Restore next device to resolving list in Controller. */
datcCb.resListRestoreHdl = AppAddNextDevToResList(datcCb.resListRestoreHdl);

if (datcCb.resListRestoreHdl == APP_DB_HDL_NONE)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ static const attCfg_t datsAttCfg =
{
15, /* ATT server service discovery connection idle timeout in seconds */
241, /* desired ATT MTU */
ATT_MAX_TRANS_TIMEOUT, /* transcation timeout in seconds */
ATT_MAX_TRANS_TIMEOUT, /* transaction timeout in seconds */
4 /* number of queued prepare writes supported by server */
};

Expand Down Expand Up @@ -490,7 +490,7 @@ static void datsPrivAddDevToResListInd(dmEvt_t *pMsg)
/* Set the advertising peer address. */
datsPrivAddDevToResList(datsCb.resListRestoreHdl);

/* Retore next device to resolving list in Controller. */
/* Restore next device to resolving list in Controller. */
datsCb.resListRestoreHdl = AppAddNextDevToResList(datsCb.resListRestoreHdl);

if (datsCb.resListRestoreHdl == APP_DB_HDL_NONE)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
struct
{
uint16_t hdlList[DM_CONN_MAX][APP_DB_HDL_LIST_LEN]; /*! Cached handle list */
wsfHandlerId_t handlerId; /*! WSF hander ID */
wsfHandlerId_t handlerId; /*! WSF handler ID */
bool_t scanning; /*! TRUE if scanning */
bool_t autoConnect; /*! TRUE if auto-connecting */
uint8_t discState[DM_CONN_MAX]; /*! Service discovery state */
Expand Down Expand Up @@ -162,7 +162,7 @@ static const attCfg_t locatorAttCfg =
{
15, /* ATT server service discovery connection idle timeout in seconds */
23, /* desired ATT MTU */
ATT_MAX_TRANS_TIMEOUT, /* transcation timeout in seconds */
ATT_MAX_TRANS_TIMEOUT, /* transaction timeout in seconds */
4 /* number of queued prepare writes supported by server */
};

Expand Down Expand Up @@ -234,7 +234,7 @@ static const attcDiscCfg_t locatorDiscCfgList[] =
/* Write: GATT service changed ccc descriptor */
{locatorCccIndVal, sizeof(locatorCccIndVal), (GATT_SC_CCC_HDL_IDX + LOCATOR_DISC_GATT_START)},

/* Write: GATT clinet supported features */
/* Write: GATT client supported features */
{locatorCsfVal, sizeof(locatorCsfVal), (GATT_CSF_HDL_IDX + LOCATOR_DISC_GATT_START)}
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ typedef struct
{
uint16_t hdlList[APP_DB_HDL_LIST_LEN]; /*! Cached handle list */
medcIf_t *pIf; /*! Profile interface */
wsfHandlerId_t handlerId; /*! WSF hander ID */
wsfHandlerId_t handlerId; /*! WSF handler ID */
uint16_t autoUuid[MEDC_MAX_AUTO_UUID]; /*! Service UUID for autoconnect */
bool_t scanning; /*! TRUE if scanning */
bool_t autoConnect; /*! TRUE if auto-connecting */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ static const attCfg_t medcPlxpAttCfg =
{
15, /* ATT server service discovery connection idle timeout in seconds */
MEDC_PLX_DEFAULT_MTU, /* desired ATT MTU */
ATT_MAX_TRANS_TIMEOUT, /* transcation timeout in seconds */
ATT_MAX_TRANS_TIMEOUT, /* transaction timeout in seconds */
4 /* number of queued prepare writes supported by server */
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ enum
/* Start of cached weight scale service handles; begins after DIS */
#define MEDC_DISC_WSS_START (MEDC_DISC_DIS_START + DIS_HDL_LIST_LEN)

/* Start of User Data Service handles; begins after weight scale serivce */
/* Start of User Data Service handles; begins after weight scale service */
#define MEDC_DISC_UDS_START (MEDC_DISC_WSS_START + WSPC_WSS_HDL_LIST_LEN)

/* Total cached handle list length */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ typedef struct
typedef struct
{
medsIf_t *pIf; /*! Profile interface */
wsfHandlerId_t handlerId; /*! WSF hander ID */
wsfHandlerId_t handlerId; /*! WSF handler ID */
} medsCb_t;

/**************************************************************************************************
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ static const attCfg_t medsPlxAttCfg =
{
15, /* ATT server service discovery connection idle timeout in seconds */
MEDS_PLX_DEFAULT_MTU, /* desired ATT MTU */
ATT_MAX_TRANS_TIMEOUT, /* transcation timeout in seconds */
ATT_MAX_TRANS_TIMEOUT, /* transaction timeout in seconds */
4 /* number of queued prepare writes supported by server */
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ enum
/* Task handler ID */
static wsfHandlerId_t sensorHandlerId;

/* App extention callback */
/* App extension callback */
static sensorExtCback_t sensorExtCback;

/**************************************************************************************************
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -975,7 +975,7 @@ static void tagProcMsg(dmEvt_t *pMsg)
/* Set the advertising peer address. */
tagPrivAddDevToResListInd(tagCb.resListRestoreHdl);

/* Retore next device to resolving list in Controller. */
/* Restore next device to resolving list in Controller. */
tagCb.resListRestoreHdl = AppAddNextDevToResList(tagCb.resListRestoreHdl);

if (tagCb.resListRestoreHdl == APP_DB_HDL_NONE)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ static wsfHandlerId_t uriBeaconHandlerId;
static wsfTimer_t uriBeaconAdvTimer;
static uint8_t uriBeaconAdvType;

/* App extention callback */
/* App extension callback */
static uribeaconExtCback_t uriBeaconExtCback;

/**************************************************************************************************
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ extern "C" {
/*! \addtogroup STACK_ATTC_API
* \{ */
/** \name ATT Client Discovery and Configuration Settings
* Settings used to configurate ATT Discovery procedure for ATT Clients.
* Settings used to configure ATT Discovery procedure for ATT Clients.
*/
/**@{*/
#define ATTC_SET_UUID_128 0x01 /*!< \brief Set if the UUID is 128 bits in length */
Expand Down Expand Up @@ -149,7 +149,7 @@ typedef struct
{
wsfTimerTicks_t discIdleTimeout; /*!< \brief ATT server service discovery connection idle timeout in seconds */
uint16_t mtu; /*!< \brief desired ATT MTU */
uint8_t transTimeout; /*!< \brief transcation timeout in seconds */
uint8_t transTimeout; /*!< \brief transaction timeout in seconds */
uint8_t numPrepWrites; /*!< \brief number of queued prepare writes supported by server */
} attCfg_t;

Expand Down Expand Up @@ -358,9 +358,9 @@ typedef struct
/*! \brief ATT client discovery control block */
typedef struct
{
attcDiscChar_t **pCharList; /*!< \brief Characterisic list for discovery */
attcDiscChar_t **pCharList; /*!< \brief Characteristic list for discovery */
uint16_t *pHdlList; /*!< \brief Characteristic handle list */
attcDiscCfg_t *pCfgList; /*!< \brief Characterisic list for configuration */
attcDiscCfg_t *pCfgList; /*!< \brief Characteristic list for configuration */
uint8_t charListLen; /*!< \brief Characteristic and handle list length */
uint8_t cfgListLen; /*!< \brief Configuration list length */

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ extern "C" {
#define ATT_READ_TYPE_RSP_LEN 2 /*!< \brief Read type response length. */
#define ATT_READ_REQ_LEN 3 /*!< \brief Read request length. */
#define ATT_READ_RSP_LEN 1 /*!< \brief Read response length. */
#define ATT_READ_BLOB_REQ_LEN 5 /*!< \brief Read blob request legnth. */
#define ATT_READ_BLOB_REQ_LEN 5 /*!< \brief Read blob request length. */
#define ATT_READ_BLOB_RSP_LEN 1 /*!< \brief Read blob response length. */
#define ATT_READ_MULT_REQ_LEN 1 /*!< \brief Read multiple request length. */
#define ATT_READ_MULT_RSP_LEN 1 /*!< \brief Read multiple response length. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ extern "C" {
#define ATT_UUID_WEIGHT_MEAS 0x2A9D /*!< \brief Weight Measurement */
#define ATT_UUID_WEIGHT_SCALE_FEATURE 0x2A9E /*!< \brief Weight Scale Feature */
#define ATT_UUID_USER_CONTROL_POINT 0x2A9F /*!< \brief User Control Point */
#define ATT_UUID_RPAO 0x2AC9 /*!< \brief Resolvable Prviate Address Only */
#define ATT_UUID_RPAO 0x2AC9 /*!< \brief Resolvable Private Address Only */
#define ATT_UUID_MESH_PRV_DATA_IN 0x2ADB /*!< \brief Mesh Provisioning Data In */
#define ATT_UUID_MESH_PRV_DATA_OUT 0x2ADC /*!< \brief Mesh Provisioning Data Out */
#define ATT_UUID_MESH_PROXY_DATA_IN 0x2ADD /*!< \brief Mesh Proxy Data In */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ extern "C" {
/**@}*/

/** \name DM Unknown IDs
* Values for unknown or unspecificed device identifiers.
* Values for unknown or unspecified device identifiers.
*/
/**@{*/
/*! \brief Unknown connection ID or other error */
Expand Down Expand Up @@ -249,9 +249,9 @@ extern "C" {
#define DM_GAP_SCAN_FAST_INT_MIN 48 /*!< \brief Minimum scan interval when user initiated */
#define DM_GAP_SCAN_FAST_INT_MAX 96 /*!< \brief Maximum scan interval when user initiated */
#define DM_GAP_SCAN_FAST_WINDOW 48 /*!< \brief Scan window when user initiated */
#define DM_GAP_SCAN_SLOW_INT_1 2048 /*!< \brief Scan interval 1 when background scannning */
#define DM_GAP_SCAN_SLOW_INT_1 2048 /*!< \brief Scan interval 1 when background scanning */
#define DM_GAP_SCAN_SLOW_WINDOW_1 18 /*!< \brief Scan window 1 when background scanning */
#define DM_GAP_SCAN_SLOW_INT_2 4096 /*!< \brief Scan interval 2 when background scannning */
#define DM_GAP_SCAN_SLOW_INT_2 4096 /*!< \brief Scan interval 2 when background scanning */
#define DM_GAP_SCAN_SLOW_WINDOW_2 36 /*!< \brief Scan window 2 when background scanning */
#define DM_GAP_ADV_FAST_INT_MIN_1 48 /*!< \brief Minimum advertising interval 1 when user initiated */
#define DM_GAP_ADV_FAST_INT_MAX_1 96 /*!< \brief Maximum advertising interval 1 when user initiated */
Expand All @@ -269,9 +269,9 @@ extern "C" {
#define DM_GAP_SCAN_CODED_FAST_INT_MIN 144 /*!< \brief Minimum scan interval when user initiated on LE Coded PHY */
#define DM_GAP_SCAN_CODED_FAST_INT_MAX 288 /*!< \brief Maximum scan interval when user initiated on LE Coded PHY */
#define DM_GAP_SCAN_CODED_FAST_WINDOW 144 /*!< \brief Scan window when user initiated on LE Coded PHY */
#define DM_GAP_SCAN_CODED_SLOW_INT_1 6144 /*!< \brief Scan interval 1 when background scannning on LE Coded PHY */
#define DM_GAP_SCAN_CODED_SLOW_INT_1 6144 /*!< \brief Scan interval 1 when background scanning on LE Coded PHY */
#define DM_GAP_SCAN_CODED_SLOW_WINDOW_1 54 /*!< \brief Scan window 1 when background scanning on LE Coded PHY */
#define DM_GAP_SCAN_CODED_SLOW_INT_2 12288 /*!< \brief Scan interval 2 when background scannning on LE Coded PHY */
#define DM_GAP_SCAN_CODED_SLOW_INT_2 12288 /*!< \brief Scan interval 2 when background scanning on LE Coded PHY */
#define DM_GAP_SCAN_CODED_SLOW_WINDOW_2 108 /*!< \brief Scan window 2 when background scanning on LE Coded PHY */
#define DM_GAP_ADV_CODED_FAST_INT_MIN_1 144 /*!< \brief Minimum advertising interval 1 when user initiated on LE Coded PHY */
#define DM_GAP_ADV_CODED_FAST_INT_MAX_1 288 /*!< \brief Maximum advertising interval 1 when user initiated on LE Coded PHY */
Expand Down Expand Up @@ -498,7 +498,7 @@ enum
DM_SEC_ENCRYPT_FAIL_IND, /*!< \brief Encryption failed */
DM_SEC_AUTH_REQ_IND, /*!< \brief PIN or OOB data requested for pairing */
DM_SEC_KEY_IND, /*!< \brief Security key indication */
DM_SEC_LTK_REQ_IND, /*!< \brief LTK requested for encyption */
DM_SEC_LTK_REQ_IND, /*!< \brief LTK requested for encryption */
DM_SEC_PAIR_IND, /*!< \brief Incoming pairing request from master */
DM_SEC_SLAVE_REQ_IND, /*!< \brief Incoming security request from slave */
DM_SEC_CALC_OOB_IND, /*!< \brief Result of OOB Confirm Calculation Generation */
Expand Down Expand Up @@ -1650,7 +1650,7 @@ void DmScanSetAddrType(uint8_t addrType);
* successful receive.
* \param syncTimeout Synchronization timeout.
*
* \return Sync indentifier.
* \return Sync identifier.
*/
/*************************************************************************************************/
dmSyncId_t DmSyncStart(uint8_t advSid, uint8_t advAddrType, const uint8_t *pAdvAddr, uint16_t skip,
Expand Down Expand Up @@ -1885,7 +1885,7 @@ void DmPastSetInfoTrsf(dmConnId_t connId, uint16_t serviceData, uint8_t advHandl
/*************************************************************************************************/
/*!
* \brief Specify how the Controller should process periodic advertising synchronization
* information received from the device identified by the connnection handle.
* information received from the device identified by the connection handle.
*
* \param connId Connection identifier.
* \param mode Action to be taken when periodic advertising info is received.
Expand Down Expand Up @@ -3113,7 +3113,7 @@ void DmSecCompareRsp(dmConnId_t connId, bool_t valid);
/*!
* \brief This function returns the 6-digit compare value for the specified 128-bit confirm value.
*
* \param pConfirm Pointer to 128-bit comfirm value.
* \param pConfirm Pointer to 128-bit confirm value.
*
* \return Six-digit compare value.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,7 @@ typedef struct
uint16_t supportedMaxRxTime; /*!< \brief Supported maximum Rx time. */
} hciLeReadMaxDataLenEvt_t;

/*! \brief LE remote connetion parameter request event */
/*! \brief LE remote connection parameter request event */
typedef struct
{
wsfMsgHdr_t hdr; /*!< \brief Event header. */
Expand Down Expand Up @@ -702,7 +702,7 @@ typedef struct
uint16_t cisHandle; /*!< \brief CIS connection handle. */
uint32_t cigSyncDelayUsec; /*!< \brief CIG synchronization delay in usec. */
uint32_t cisSyncDelayUsec; /*!< \brief CIS synchronization delay in usec. */
uint32_t transLatMToSUsec; /*!< \brief The maximum time, in msec, for transmission of SDUs of all CISes from mater to slave. */
uint32_t transLatMToSUsec; /*!< \brief The maximum time, in msec, for transmission of SDUs of all CISes from master to slave. */
uint32_t transLatSToMUsec; /*!< \brief The maximum time, in msec, for transmission of SDUs of all CISes from slave to master. */
uint8_t phyMToS; /*!< \brief Master to slave PHY. */
uint8_t phySToM; /*!< \brief Slave to master PHY. */
Expand Down Expand Up @@ -1234,7 +1234,7 @@ typedef void (*hciIsoCback_t)(uint8_t *pData);

/*! \brief HCI flow control callback type
*
* This callback function manages flow control in the TX path betrween the stack and HCI.
* This callback function manages flow control in the TX path between the stack and HCI.
*
* \param connId Connection handle.
* \param flowDisabled TRUE if flow is disabled.
Expand Down Expand Up @@ -1747,7 +1747,7 @@ void HciLeReadChanMapCmd(uint16_t handle);

/*************************************************************************************************/
/*!
* \brief HCI LE read local supported feautre command.
* \brief HCI LE read local supported feature command.
*
* \return None.
*/
Expand Down Expand Up @@ -2793,7 +2793,7 @@ void HciLeSetCigParamsCmd(HciCisCigParams_t *pCigParam);
/*!
* \brief HCI LE create CIS command.
*
* \param numCis Nunber of CISes.
* \param numCis Number of CISes.
* \param pCreateCisParam Parameters for creating connected isochronous stream.
*
* \return None.
Expand Down Expand Up @@ -2828,7 +2828,7 @@ void HciLeRejectCisReqCmd(uint16_t connHandle, uint8_t reason);
/*!
* \brief HCI LE remove CIG command.
*
* \param cigId Identifer of a CIG.
* \param cigId Identifier of a CIG.
*
* \return None.
*/
Expand Down
Loading

0 comments on commit cd646d9

Please sign in to comment.