From nobody Sat Feb 7 11:53:04 2026 Received: from mail-wm1-f47.google.com (mail-wm1-f47.google.com [209.85.128.47]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 522623112B3 for ; Tue, 27 Jan 2026 17:36:10 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.47 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1769535377; cv=none; b=D1w3xWVEYS+P7B6+GOdWpYy3asxUrIkCO2ZBAjyYZdxTdIn0XSRXUcuO4hZBwO3Ar0NxNB/NLrijqThl9Tx10dLz1r7BTjQkzLrOleupLEnZ4SlrvjcQTZnIHngQa0L4z9D5mLc2S+h1BS8MsbTJGVacnv8iGGcNpbgFd7t6dEw= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1769535377; c=relaxed/simple; bh=/SjArWhl91MYDI90bvd0/eW+OI/xdQ6cfMLtNYKxT40=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version:Content-Type; b=BsKnMfNun/0hUlMC+swEQaKoSUdooOLcfyaQVwh8dZhIekyE5NniYytRRLQCvlC8Ke4EPa+0ZyK8apupKVeC2XInNod5s7kwBmOAtscPLg/9CXQsENK2P/kdfgp3/BcKyrK1ozYTzIj4yBy5Y46BUHcR6YWKpceMGLiW2gYO7xI= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=PskTMlI9; arc=none smtp.client-ip=209.85.128.47 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="PskTMlI9" Received: by mail-wm1-f47.google.com with SMTP id 5b1f17b1804b1-4801d7c72a5so46597285e9.0 for ; Tue, 27 Jan 2026 09:36:10 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1769535369; x=1770140169; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=uxXfz+R2HYXLp2KDrxuAaoGBhmk4g7IaH8iP247DXBY=; b=PskTMlI9fiiA67OGNeV/FB8hPFMa9NIueuYtGsh6yg43iUgb3sSJbnmijXMiAiUIJU Zk2+ue+aRHAx8se0IT5M4dll3qtTx6XqtcG4blDcUOD2xi8MKgsy+Xcs4p/uimW7Rhod AasLmN1hyCiH4ImkeDt0BVsw86UDxSW2a7nqSBou9y/G0YV3ANn4OyD59VIfjiKOdvjS NDV+8V57gKpuEfdCA0B9nKOYCTvmCP1iDwyY/FB+NX8M/jSvcOHhl1dOgP1kyxO+Y5uI 70rKX2Aq5E3LwoU6tsmCa++XZGfENewE78pAxh/LL9xc+rqk9NxyFQYrhFPsLIbz3+tE IKdg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1769535369; x=1770140169; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-gg:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=uxXfz+R2HYXLp2KDrxuAaoGBhmk4g7IaH8iP247DXBY=; b=lC+ebo9rO/B4lbHrctDA/JHsW1Y1qf2yqWyZuEN7YLYvVZ+1XoPh9dYSE6JmymoUMF HhtvC8VYuUbDoSs93/E732yxcDR7t3ktGSgWXtTK3C0BZBADtG/lhHoUhI/0QkWvo/WP B0mFGHKOL/TEEjUQ9AanizfEVrAZxOrU9sQN9o60TFbIYFLXzkTVRUfCL3mR/Si5NH3d 6kreJB8S89jWQQ1GOllO7QdAANDtWqnDv2bw1XHUkcwplRYE46c65yCP+luXreJeqjLj ol2N+0reMUB7hLDfIO+9FVcZ88LneK3d99Cm2C5Cl5otbH7WcSSTAmfqqEbktIfbhL19 aGFg== X-Forwarded-Encrypted: i=1; AJvYcCUNUhJpmAYtaykYTBRo5kHoKO4+IVlVXEi3xTfPk+LJ/8NiID/a3zrfs53zUy+iX2Dj56068t34UDESbFE=@vger.kernel.org X-Gm-Message-State: AOJu0YwlaZQtbZ0XPMtY+v7vW314yOl3mh8rzYf1u4+3AZ5o8SpQN5ze Pm6IUa93XTJpSyqWwZ794ddgUlZztB75cvZFvTniH5a55vXOT+HJ8crx X-Gm-Gg: AZuq6aLNy4m1LL5VsklmKwI0Fd/IRmCxUNkeyHesOuBgI+bvsQ34xSb8nefduHmzawX tNTS24f6654LdXf/YPA5h16FyvHbI0eKvBsXJSdqiKbb63o8QYOQ9Nh9U8aVqGT2dHyF/mcnl/a haCZnQOJ1srlQARNQ/0rwzd208MR9Qj12dnwZoe1WQe2TuXg7tz/cJ5FPKvy1O9Q53bBIikVDPq qKFHu8LapMH6G+aHy+XLmLjpcqGE6SgFzbFcW2HOFPf6upDcA+WT8heOhZ2NZE1Ck/U34jgULdG /WRpaW0BhlHFYE7rBfps9yvh0WXstTym+ZPF296LydGHf+n9Jo9yHFZ8W1QrKozrEzRLliOy/8Y KP+oRf2ZY8hXObhesjluZXS521YtZGiapm0QEzbUUWmNXwsnZCRgjHyBREUuGMkReZ7l7ivdatT mRvuqOGeqyBU2S0aHk5GhhCXylfHLwV76Y0bxCyl64StQyUQ== X-Received: by 2002:a05:600c:3113:b0:47e:dc64:f1c6 with SMTP id 5b1f17b1804b1-48069c3fb40mr33003035e9.6.1769535368338; Tue, 27 Jan 2026 09:36:08 -0800 (PST) Received: from DB-VM.1337.ma ([197.230.240.146]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-48066c4f3edsm72156975e9.15.2026.01.27.09.36.06 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Jan 2026 09:36:07 -0800 (PST) From: Taha Ed-Dafili <0rayn.dev@gmail.com> To: jic23@kernel.org Cc: me@brighamcampbell.com, skhan@linuxfoundation.org, linux-kernel-mentees-archive@lists.linuxfoundation.org, dlechner@baylibre.com, nuno.sa@analog.com, andy@kernel.org, corbet@lwn.net, linux-iio@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Taha Ed-Dafili <0rayn.dev@gmail.com> Subject: [PATCH] docs: iio: adxl345: Fix typos, units, and grammatical errors Date: Tue, 27 Jan 2026 12:34:51 -0500 Message-ID: <20260127173543.72423-1-0rayn.dev@gmail.com> X-Mailer: git-send-email 2.47.3 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Clean up the ADXL345 documentation to improve technical accuracy and readability: - Fix "latent" to "latency" in double tap descriptions. - Correct the threshold unit from "g/LSB" to "mg/LSB" to match the datasheet. - Standardize "axis" to "axes" for plural references. - Change "generic purpose" to "general purpose". - Fix minor subject-verb agreement and punctuation errors. Signed-off-by: Taha Ed-Dafili <0rayn.dev@gmail.com> Reviewed-by: Randy Dunlap Tested-by: Randy Dunlap --- Documentation/iio/adxl345.rst | 104 +++++++++++++++++----------------- 1 file changed, 52 insertions(+), 52 deletions(-) diff --git a/Documentation/iio/adxl345.rst b/Documentation/iio/adxl345.rst index bb19d64f67c3..020b512cdb74 100644 --- a/Documentation/iio/adxl345.rst +++ b/Documentation/iio/adxl345.rst @@ -12,16 +12,16 @@ This driver supports Analog Device's ADXL345/375 on SPI= /I2C bus. * `ADXL345 `_ * `ADXL375 `_ =20 -The ADXL345 is a generic purpose low power, 3-axis accelerometer with sele= ctable +The ADXL345 is a general purpose low power, 3-axis accelerometer with sele= ctable measurement ranges. The ADXL345 supports the =C2=B12 g, =C2=B14 g, =C2=B18= g, and =C2=B116 g ranges. =20 2. Device Attributes =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -Each IIO device, has a device folder under ``/sys/bus/iio/devices/iio:devi= ceX``, +Each IIO device has a device folder under ``/sys/bus/iio/devices/iio:devic= eX``, where X is the IIO index of the device. Under these folders reside a set of device files, depending on the characteristics and features of the hardware -device in questions. These files are consistently generalized and document= ed in +device in question. These files are consistently generalized and documente= d in the IIO ABI documentation. =20 The following table shows the ADXL345 related device files, found in the @@ -42,7 +42,7 @@ specific device folder path ``/sys/bus/iio/devices/iio:de= viceX``. +-------------------------------------------+-----------------------------= -----------------------------+ | in_accel_x_raw | Raw X-axis accelerometer cha= nnel value. | +-------------------------------------------+-----------------------------= -----------------------------+ -| in_accel_y_calibbias | y-axis acceleration offset c= orrection | +| in_accel_y_calibbias | Y-axis acceleration offset c= orrection | +-------------------------------------------+-----------------------------= -----------------------------+ | in_accel_y_raw | Raw Y-axis accelerometer cha= nnel value. | +-------------------------------------------+-----------------------------= -----------------------------+ @@ -68,7 +68,7 @@ present, simply assume its value is 0. +-------------------------------------+---------------------------+ | Channel type | Measurement unit | +-------------------------------------+---------------------------+ -| Acceleration on X, Y, and Z axis | Meters per second squared | +| Acceleration on X, Y, and Z axes | Meters per second squared | +-------------------------------------+---------------------------+ =20 Sensor Events @@ -78,8 +78,8 @@ Specific IIO events are triggered by their corresponding = interrupts. The sensor driver supports either none or a single active interrupt (INT) line, selec= table from the two available options: INT1 or INT2. The active INT line should be specified in the device tree. If no INT line is configured, the sensor def= aults -to FIFO bypass mode, where event detection is disabled and only X, Y, and = Z axis -measurements are available. +to FIFO bypass mode, where event detection is disabled and only individual +X, Y, and Z axes measurements are available. =20 The table below lists the ADXL345-related device files located in the device-specific path: ``/sys/bus/iio/devices/iio:deviceX/events``. @@ -87,45 +87,45 @@ Note that activity and inactivity detection are DC-coup= led by default; therefore, only the AC-coupled activity and inactivity events are explicit= ly listed. =20 -+---------------------------------------------+---------------------------= ------------------+ -| Event handle | Description = | -+---------------------------------------------+---------------------------= ------------------+ -| in_accel_gesture_doubletap_en | Enable double tap detectio= n on all axis | -+---------------------------------------------+---------------------------= ------------------+ -| in_accel_gesture_doubletap_reset_timeout | Double tap window in [us] = | -+---------------------------------------------+---------------------------= ------------------+ -| in_accel_gesture_doubletap_tap2_min_delay | Double tap latent in [us] = | -+---------------------------------------------+---------------------------= ------------------+ -| in_accel_gesture_singletap_timeout | Single tap duration in [us= ] | -+---------------------------------------------+---------------------------= ------------------+ -| in_accel_gesture_singletap_value | Single tap threshold value= in 62.5/LSB | -+---------------------------------------------+---------------------------= ------------------+ -| in_accel_mag_falling_period | Inactivity time in seconds= | -+---------------------------------------------+---------------------------= ------------------+ -| in_accel_mag_falling_value | Inactivity threshold value= in 62.5/LSB | -+---------------------------------------------+---------------------------= ------------------+ -| in_accel_mag_adaptive_rising_en | Enable AC coupled activity= on X axis | -+---------------------------------------------+---------------------------= ------------------+ -| in_accel_mag_adaptive_falling_period | AC coupled inactivity time= in seconds | -+---------------------------------------------+---------------------------= ------------------+ -| in_accel_mag_adaptive_falling_value | AC coupled inactivity thre= shold in 62.5/LSB | -+---------------------------------------------+---------------------------= ------------------+ -| in_accel_mag_adaptive_rising_value | AC coupled activity thresh= old in 62.5/LSB | -+---------------------------------------------+---------------------------= ------------------+ -| in_accel_mag_rising_en | Enable activity detection = on X axis | -+---------------------------------------------+---------------------------= ------------------+ -| in_accel_mag_rising_value | Activity threshold value i= n 62.5/LSB | -+---------------------------------------------+---------------------------= ------------------+ -| in_accel_x_gesture_singletap_en | Enable single tap detectio= n on X axis | -+---------------------------------------------+---------------------------= ------------------+ -| in_accel_x&y&z_mag_falling_en | Enable inactivity detectio= n on all axis | -+---------------------------------------------+---------------------------= ------------------+ -| in_accel_x&y&z_mag_adaptive_falling_en | Enable AC coupled inactivi= ty on all axis | -+---------------------------------------------+---------------------------= ------------------+ -| in_accel_y_gesture_singletap_en | Enable single tap detectio= n on Y axis | -+---------------------------------------------+---------------------------= ------------------+ -| in_accel_z_gesture_singletap_en | Enable single tap detectio= n on Z axis | -+---------------------------------------------+---------------------------= ------------------+ ++---------------------------------------------+---------------------------= ---------------------+ +| Event handle | Description = | ++---------------------------------------------+---------------------------= ---------------------+ +| in_accel_gesture_doubletap_en | Enable double tap detectio= n on all axes | ++---------------------------------------------+---------------------------= ---------------------+ +| in_accel_gesture_doubletap_reset_timeout | Double tap window in [us] = | ++---------------------------------------------+---------------------------= ---------------------+ +| in_accel_gesture_doubletap_tap2_min_delay | Double tap latency in [us]= | ++---------------------------------------------+---------------------------= ---------------------+ +| in_accel_gesture_singletap_timeout | Single tap duration in [us= ] | ++---------------------------------------------+---------------------------= ---------------------+ +| in_accel_gesture_singletap_value | Single tap threshold value= in 62.5 mg/LSB | ++---------------------------------------------+---------------------------= ---------------------+ +| in_accel_mag_falling_period | Inactivity time in seconds= | ++---------------------------------------------+---------------------------= ---------------------+ +| in_accel_mag_falling_value | Inactivity threshold value= in 62.5 mg/LSB | ++---------------------------------------------+---------------------------= ---------------------+ +| in_accel_mag_adaptive_rising_en | Enable AC coupled activity= on X axis | ++---------------------------------------------+---------------------------= ---------------------+ +| in_accel_mag_adaptive_falling_period | AC coupled inactivity time= in seconds | ++---------------------------------------------+---------------------------= ---------------------+ +| in_accel_mag_adaptive_falling_value | AC coupled inactivity thre= shold in 62.5 mg/LSB | ++---------------------------------------------+---------------------------= ---------------------+ +| in_accel_mag_adaptive_rising_value | AC coupled activity thresh= old in 62.5 mg/LSB | ++---------------------------------------------+---------------------------= ---------------------+ +| in_accel_mag_rising_en | Enable activity detection = on X axis | ++---------------------------------------------+---------------------------= ---------------------+ +| in_accel_mag_rising_value | Activity threshold value i= n 62.5 mg/LSB | ++---------------------------------------------+---------------------------= ---------------------+ +| in_accel_x_gesture_singletap_en | Enable single tap detectio= n on X axis | ++---------------------------------------------+---------------------------= ---------------------+ +| in_accel_x&y&z_mag_falling_en | Enable inactivity detectio= n on all axes | ++---------------------------------------------+---------------------------= ---------------------+ +| in_accel_x&y&z_mag_adaptive_falling_en | Enable AC coupled inactivi= ty on all axes | ++---------------------------------------------+---------------------------= ---------------------+ +| in_accel_y_gesture_singletap_en | Enable single tap detectio= n on Y axis | ++---------------------------------------------+---------------------------= ---------------------+ +| in_accel_z_gesture_singletap_en | Enable single tap detectio= n on Z axis | ++---------------------------------------------+---------------------------= ---------------------+ =20 Please refer to the sensor's datasheet for a detailed description of this functionality. @@ -133,14 +133,14 @@ functionality. Manually setting the **ODR** will cause the driver to estimate default val= ues for inactivity detection timing, where higher ODR values correspond to lon= ger default wait times, and lower ODR values to shorter ones. If these default= s do -not meet your application=E2=80=99s needs, you can explicitly configure th= e inactivity +not meet your application's needs, you can explicitly configure the inacti= vity wait time. Setting this value to 0 will revert to the default behavior. =20 When changing the **g range** configuration, the driver attempts to estima= te appropriate activity and inactivity thresholds by scaling the default valu= es based on the ratio of the previous range to the new one. The resulting thr= eshold will never be zero and will always fall between 1 and 255, corresponding t= o up -to 62.5=E2=80=AFg/LSB as specified in the datasheet. However, you can over= ride these +to 62.5 mg/LSB as specified in the datasheet. However, you can override th= ese estimated thresholds by setting explicit values. =20 When **activity** and **inactivity** events are enabled, the driver @@ -148,7 +148,7 @@ automatically manages hysteresis behavior by setting th= e **link** and **auto-sleep** bits. The link bit connects the activity and inactivity functions, so that one follows the other. The auto-sleep function puts the sensor into sleep mode when inactivity is detected, reducing power consump= tion -to the sub-12.5=E2=80=AFHz rate. +to the sub-12.5 Hz rate. =20 The inactivity time is configurable between 1 and 255 seconds. In addition= to inactivity detection, the sensor also supports free-fall detection, which,= from @@ -312,10 +312,10 @@ Configure one or several events: =20 root:/sys/bus/iio/devices/iio:device0> echo 24 > ./buffer0/length =20 - ## AC coupled activity, threshold [62.5/LSB] + ## AC coupled activity, threshold [62.5 mg/LSB] root:/sys/bus/iio/devices/iio:device0> echo 6 > ./events/in_accel_= mag_adaptive_rising_value =20 - ## AC coupled inactivity, threshold, [62.5/LSB] + ## AC coupled inactivity, threshold, [62.5 mg/LSB] root:/sys/bus/iio/devices/iio:device0> echo 4 > ./events/in_accel_= mag_adaptive_falling_value =20 ## AC coupled inactivity, time [s] @@ -330,7 +330,7 @@ Configure one or several events: ## doubletap, window [us] root:/sys/bus/iio/devices/iio:device0> echo 0.025 > ./events/in_ac= cel_gesture_doubletap_reset_timeout =20 - ## doubletap, latent [us] + ## doubletap, latency [us] root:/sys/bus/iio/devices/iio:device0> echo 0.025 > ./events/in_ac= cel_gesture_doubletap_tap2_min_delay =20 ## AC coupled activity, enable --=20 2.47.3