diff mbox series

[v3,1/3] Bluetooth: use inclusive language in HCI role comments

Message ID 20210604162616.v3.1.I444f42473f263fed77f2586eb4b01d6752df0de4@changeid (mailing list archive)
State Awaiting Upstream
Delegated to: Netdev Maintainers
Headers show
Series [v3,1/3] Bluetooth: use inclusive language in HCI role comments | expand

Checks

Context Check Description
netdev/tree_selection success Guessing tree name failed - patch did not apply

Commit Message

Archie Pusaka June 4, 2021, 8:26 a.m. UTC
From: Archie Pusaka <apusaka@chromium.org>

This patch replaces some non-inclusive terms based on the appropriate
language mapping table compiled by the Bluetooth SIG:
https://specificationrefs.bluetooth.com/language-mapping/Appropriate_Language_Mapping_Table.pdf

Specifically, these terms are replaced:
master -> initiator (for smp) or central (everything else)
slave  -> responder (for smp) or peripheral (everything else)

The #define preprocessor terms are unchanged for now to not disturb
dependent APIs.

Signed-off-by: Archie Pusaka <apusaka@chromium.org>

---

Changes in v3:
* Remove the #define terms from change

 net/bluetooth/hci_conn.c   | 8 ++++----
 net/bluetooth/hci_event.c  | 6 +++---
 net/bluetooth/l2cap_core.c | 2 +-
 net/bluetooth/smp.c        | 6 +++---
 4 files changed, 11 insertions(+), 11 deletions(-)

Comments

Bastien Nocera June 4, 2021, 8:38 a.m. UTC | #1
On Fri, 2021-06-04 at 16:26 +0800, Archie Pusaka wrote:
> 
> The #define preprocessor terms are unchanged for now to not disturb
> dependent APIs.

Could we add new defines, and deprecate the old ones? Something akin
to that would help migrate the constants, over time:
https://gitlab.gnome.org/GNOME/glib/blob/master/glib/gmacros.h#L686-716
Archie Pusaka June 4, 2021, 8:56 a.m. UTC | #2
Hi Bastien,

Thanks! That was a great input.
I'm not sure though, do we have a standard, proper way to deprecate macros?
Or does a simple /* deprecated */ comment works for now?

Cheers,
Archie


On Fri, 4 Jun 2021 at 16:39, Bastien Nocera <hadess@hadess.net> wrote:
>
> On Fri, 2021-06-04 at 16:26 +0800, Archie Pusaka wrote:
> >
> > The #define preprocessor terms are unchanged for now to not disturb
> > dependent APIs.
>
> Could we add new defines, and deprecate the old ones? Something akin
> to that would help migrate the constants, over time:
> https://gitlab.gnome.org/GNOME/glib/blob/master/glib/gmacros.h#L686-716
>
Bastien Nocera June 4, 2021, 9:09 a.m. UTC | #3
On Fri, 2021-06-04 at 16:56 +0800, Archie Pusaka wrote:
> Hi Bastien,
> 
> Thanks! That was a great input.
> I'm not sure though, do we have a standard, proper way to deprecate
> macros?
> Or does a simple /* deprecated */ comment works for now?

I think we might need to add #ifdef around those instead unfortunately,
something like "#ifndef BLUETOOTH_NO_DEPRECATED_CONSTANTS" around the
old names.

> 
> Cheers,
> Archie
> 
> 
> On Fri, 4 Jun 2021 at 16:39, Bastien Nocera <hadess@hadess.net>
> wrote:
> > 
> > On Fri, 2021-06-04 at 16:26 +0800, Archie Pusaka wrote:
> > > 
> > > The #define preprocessor terms are unchanged for now to not
> > > disturb
> > > dependent APIs.
> > 
> > Could we add new defines, and deprecate the old ones? Something
> > akin
> > to that would help migrate the constants, over time:
> > https://gitlab.gnome.org/GNOME/glib/blob/master/glib/gmacros.h#L686-716
> >
Marcel Holtmann June 4, 2021, 3:27 p.m. UTC | #4
Hi Archie,

> This patch replaces some non-inclusive terms based on the appropriate
> language mapping table compiled by the Bluetooth SIG:
> https://specificationrefs.bluetooth.com/language-mapping/Appropriate_Language_Mapping_Table.pdf
> 
> Specifically, these terms are replaced:
> master -> initiator (for smp) or central (everything else)
> slave  -> responder (for smp) or peripheral (everything else)
> 
> The #define preprocessor terms are unchanged for now to not disturb
> dependent APIs.
> 
> Signed-off-by: Archie Pusaka <apusaka@chromium.org>
> 
> ---
> 
> Changes in v3:
> * Remove the #define terms from change
> 
> net/bluetooth/hci_conn.c   | 8 ++++----
> net/bluetooth/hci_event.c  | 6 +++---
> net/bluetooth/l2cap_core.c | 2 +-
> net/bluetooth/smp.c        | 6 +++---
> 4 files changed, 11 insertions(+), 11 deletions(-)

all 3 patches have been applied to bluetooth-next tree.

Regards

Marcel
diff mbox series

Patch

diff --git a/net/bluetooth/hci_conn.c b/net/bluetooth/hci_conn.c
index ea0f9cdaa6b1..2b5059a56cda 100644
--- a/net/bluetooth/hci_conn.c
+++ b/net/bluetooth/hci_conn.c
@@ -257,7 +257,7 @@  int hci_disconnect(struct hci_conn *conn, __u8 reason)
 {
 	BT_DBG("hcon %p", conn);
 
-	/* When we are master of an established connection and it enters
+	/* When we are central of an established connection and it enters
 	 * the disconnect timeout, then go ahead and try to read the
 	 * current clock offset.  Processing of the result is done
 	 * within the event handling and hci_clock_offset_evt function.
@@ -1109,9 +1109,9 @@  struct hci_conn *hci_connect_le(struct hci_dev *hdev, bdaddr_t *dst,
 
 	hci_req_init(&req, hdev);
 
-	/* Disable advertising if we're active. For master role
+	/* Disable advertising if we're active. For central role
 	 * connections most controllers will refuse to connect if
-	 * advertising is enabled, and for slave role connections we
+	 * advertising is enabled, and for peripheral role connections we
 	 * anyway have to disable it in order to start directed
 	 * advertising. Any registered advertisements will be
 	 * re-enabled after the connection attempt is finished.
@@ -1119,7 +1119,7 @@  struct hci_conn *hci_connect_le(struct hci_dev *hdev, bdaddr_t *dst,
 	if (hci_dev_test_flag(hdev, HCI_LE_ADV))
 		__hci_req_pause_adv_instances(&req);
 
-	/* If requested to connect as slave use directed advertising */
+	/* If requested to connect as peripheral use directed advertising */
 	if (conn->role == HCI_ROLE_SLAVE) {
 		/* If we're active scanning most controllers are unable
 		 * to initiate advertising. Simply reject the attempt.
diff --git a/net/bluetooth/hci_event.c b/net/bluetooth/hci_event.c
index 43c324c46c0b..da013d485f14 100644
--- a/net/bluetooth/hci_event.c
+++ b/net/bluetooth/hci_event.c
@@ -2795,9 +2795,9 @@  static void hci_conn_request_evt(struct hci_dev *hdev, struct sk_buff *skb)
 		bacpy(&cp.bdaddr, &ev->bdaddr);
 
 		if (lmp_rswitch_capable(hdev) && (mask & HCI_LM_MASTER))
-			cp.role = 0x00; /* Become master */
+			cp.role = 0x00; /* Become central */
 		else
-			cp.role = 0x01; /* Remain slave */
+			cp.role = 0x01; /* Remain peripheral */
 
 		hci_send_cmd(hdev, HCI_OP_ACCEPT_CONN_REQ, sizeof(cp), &cp);
 	} else if (!(flags & HCI_PROTO_DEFER)) {
@@ -5131,7 +5131,7 @@  static void le_conn_complete_evt(struct hci_dev *hdev, u8 status,
 		conn->dst_type = bdaddr_type;
 
 		/* If we didn't have a hci_conn object previously
-		 * but we're in master role this must be something
+		 * but we're in central role this must be something
 		 * initiated using a white list. Since white list based
 		 * connections are not "first class citizens" we don't
 		 * have full tracking of them. Therefore, we go ahead
diff --git a/net/bluetooth/l2cap_core.c b/net/bluetooth/l2cap_core.c
index 9ebb85df4db4..b76c5d00b082 100644
--- a/net/bluetooth/l2cap_core.c
+++ b/net/bluetooth/l2cap_core.c
@@ -1691,7 +1691,7 @@  static void l2cap_le_conn_ready(struct l2cap_conn *conn)
 	if (hcon->out)
 		smp_conn_security(hcon, hcon->pending_sec_level);
 
-	/* For LE slave connections, make sure the connection interval
+	/* For LE peripheral connections, make sure the connection interval
 	 * is in the range of the minimum and maximum interval that has
 	 * been configured for this connection. If not, then trigger
 	 * the connection update procedure.
diff --git a/net/bluetooth/smp.c b/net/bluetooth/smp.c
index 6777f5313838..53f984d11bc1 100644
--- a/net/bluetooth/smp.c
+++ b/net/bluetooth/smp.c
@@ -909,8 +909,8 @@  static int tk_request(struct l2cap_conn *conn, u8 remote_oob, u8 auth,
 			hcon->pending_sec_level = BT_SECURITY_HIGH;
 	}
 
-	/* If both devices have Keyoard-Display I/O, the master
-	 * Confirms and the slave Enters the passkey.
+	/* If both devices have Keyboard-Display I/O, the initiator
+	 * Confirms and the responder Enters the passkey.
 	 */
 	if (smp->method == OVERLAP) {
 		if (hcon->role == HCI_ROLE_MASTER)
@@ -3083,7 +3083,7 @@  static void bredr_pairing(struct l2cap_chan *chan)
 	if (!test_bit(HCI_CONN_ENCRYPT, &hcon->flags))
 		return;
 
-	/* Only master may initiate SMP over BR/EDR */
+	/* Only initiator may initiate SMP over BR/EDR */
 	if (hcon->role != HCI_ROLE_MASTER)
 		return;