Commit a4e43d01 authored by Rubin Gerritsen's avatar Rubin Gerritsen Committed by Carles Cufi
Browse files

Bluetooth: Samples: Use string printing functions for error codes 



When developing Bluetooth applications, you typically run into some errors.
If you are an experienced Bluetooth developer, you would typically know
how to translate the error codes into string representations.
Others might not.

This commit to adds string printing of error codes for all
samples to make them more user-friendly.

Several formatting alternatives were considered. The chosen alternative
balances code readability and FLASH size (with and without string
printing).

Example output from the peripheral_hids sample when the
peer rejects pairing:

```
Bluetooth initialized
Bluetooth authentication callbacks registered.
Advertising successfully started
Connected 5E:67:02:D3:1C:DB (random)
Security failed: 5E:67:02:D3:1C:DB (random) \
level 1 err 6 BT_SECURITY_ERR_PAIR_NOT_ALLOWED
Disconnected from 5E:67:02:D3:1C:DB (random), \
reason 0x13 BT_HCI_ERR_REMOTE_USER_TERM_CONN
```

Other alternatives that were considered:

- Use of parantheses:
```
// strings enabled
Security failed: 5E:67:02:D3:1C:DB (random) level 1 \
err BT_SECURITY_ERR_PAIR_NOT_ALLOWED(6)
Disconnected from 5E:67:02:D3:1C:DB (random), reason \
BT_HCI_ERR_REMOTE_USER_TERM_CONN(0x13)
// strings disabled
Security failed: 5E:67:02:D3:1C:DB (random) level 1 err (6)
Disconnected from 5E:67:02:D3:1C:DB (random), reason (0x13)
```

- Spaces and parantheses:
```
// strings enabled
Security failed: 5E:67:02:D3:1C:DB (random) level 1 \
err BT_SECURITY_ERR_PAIR_NOT_ALLOWED (6)
Disconnected from 5E:67:02:D3:1C:DB (random), \
reason BT_HCI_ERR_REMOTE_USER_TERM_CONN (0x13)
// strings disabled
Security failed: 5E:67:02:D3:1C:DB (random) level 1 err  (6)
Disconnected from 5E:67:02:D3:1C:DB (random), reason  (0x13)
```

- Parantheses around everything:
```
// strings enabled
Security failed: 5E:67:02:D3:1C:DB (random) level 1 \
err (BT_SECURITY_ERR_PAIR_NOT_ALLOWED(6))
Disconnected from 5E:67:02:D3:1C:DB (random), \
reason (BT_HCI_ERR_REMOTE_USER_TERM_CONN(0x13))
// strings disabled
Security failed: 5E:67:02:D3:1C:DB (random) level 1 err ((6))
Disconnected from 5E:67:02:D3:1C:DB (random), reason ((0x13))
```

- Error code first, then string representation:
```
// strings enabled
Security failed: 5E:67:02:D3:1C:DB (random) level 1 \
err 6 (BT_SECURITY_ERR_PAIR_NOT_ALLOWED)
Disconnected from 5E:67:02:D3:1C:DB (random), reason \
0x13 (BT_HCI_ERR_REMOTE_USER_TERM_CONN)
// strings disabled
Security failed: 5E:67:02:D3:1C:DB (random) level 1 err 6 ()
Disconnected from 5E:67:02:D3:1C:DB (random), reason 0x13 ()
```

- Apostrophes around error printing:
```
// strings enabled
Security failed: 5E:67:02:D3:1C:DB (random) level 1 \
err "BT_SECURITY_ERR_PAIR_NOT_ALLOWED (6)"
Disconnected from 5E:67:02:D3:1C:DB (random), reason \
"BT_HCI_ERR_REMOTE_USER_TERM_CONN (0x13)"
// strings disabled
Security failed: 5E:67:02:D3:1C:DB (random) level 1 err " (6)"
Disconnected from 5E:67:02:D3:1C:DB (random), reason " (0x13)"
```

Signed-off-by: default avatarRubin Gerritsen <rubin.gerritsen@nordicsemi.no>
parent de664204

modules/openthread/platform/ble.c

+3 −2
Original line number Diff line number Diff line
@@ -322,7 +322,8 @@ static void connected(struct bt_conn *conn, uint8_t err) 
	ot_plat_ble_connection = bt_conn_ref(conn);



	if (err) {

		LOG_WRN("Connection failed (err %u)", err);

		LOG_WRN("Connection failed err %u %s",

			err, bt_hci_err_to_str(err));

		return;

	} else if (bt_conn_get_info(conn, &info)) {

		LOG_WRN("Could not parse connection info");
@@ -342,7 +343,7 @@ static void disconnected(struct bt_conn *conn, uint8_t reason) 
{

	otError error = OT_ERROR_NONE;



	LOG_INF("Disconnected (reason %" PRIu8 ")", reason);

	LOG_INF("Disconnected, reason 0x%02x %s", reason, bt_hci_err_to_str(reason));



	if (ot_plat_ble_connection) {

		bt_conn_unref(ot_plat_ble_connection);

samples/bluetooth/bap_broadcast_assistant/src/main.c

+3 −3
Original line number Diff line number Diff line
@@ -439,7 +439,7 @@ static void connected(struct bt_conn *conn, uint8_t err) 
	(void)bt_addr_le_to_str(bt_conn_get_dst(conn), addr, sizeof(addr));



	if (err != 0) {

		printk("Failed to connect to %s (%u)\n", addr, err);

		printk("Failed to connect to %s %u %s\n", addr, err, bt_hci_err_to_str(err));



		bt_conn_unref(broadcast_sink_conn);

		broadcast_sink_conn = NULL;
@@ -466,7 +466,7 @@ static void disconnected(struct bt_conn *conn, uint8_t reason) 


	(void)bt_addr_le_to_str(bt_conn_get_dst(conn), addr, sizeof(addr));



	printk("Disconnected: %s (reason 0x%02x)\n", addr, reason);

	printk("Disconnected: %s, reason 0x%02x %s\n", addr, reason, bt_hci_err_to_str(reason));



	bt_conn_unref(broadcast_sink_conn);

	broadcast_sink_conn = NULL;
@@ -481,7 +481,7 @@ static void security_changed_cb(struct bt_conn *conn, bt_security_t level, 
		printk("Security level changed: %u\n", level);

		k_sem_give(&sem_security_updated);

	} else {

		printk("Failed to set security level: %u\n", err);

		printk("Failed to set security level: %s(%u)\n", bt_security_err_to_str(err), err);

	}

}

samples/bluetooth/bap_broadcast_sink/src/main.c

+2 −2
Original line number Diff line number Diff line
@@ -1063,7 +1063,7 @@ static void connected(struct bt_conn *conn, uint8_t err) 
	bt_addr_le_to_str(bt_conn_get_dst(conn), addr, sizeof(addr));



	if (err != 0U) {

		printk("Failed to connect to %s (%u)\n", addr, err);

		printk("Failed to connect to %s %u %s\n", addr, err, bt_hci_err_to_str(err));



		broadcast_assistant_conn = NULL;

		return;
@@ -1085,7 +1085,7 @@ static void disconnected(struct bt_conn *conn, uint8_t reason) 


	bt_addr_le_to_str(bt_conn_get_dst(conn), addr, sizeof(addr));



	printk("Disconnected: %s (reason 0x%02x)\n", addr, reason);

	printk("Disconnected: %s, reason 0x%02x %s\n", addr, reason, bt_hci_err_to_str(reason));



	bt_conn_unref(broadcast_assistant_conn);

	broadcast_assistant_conn = NULL;

samples/bluetooth/bap_unicast_client/src/main.c

+3 −3
Original line number Diff line number Diff line
@@ -395,7 +395,7 @@ static void connected(struct bt_conn *conn, uint8_t err) 
	(void)bt_addr_le_to_str(bt_conn_get_dst(conn), addr, sizeof(addr));



	if (err != 0) {

		printk("Failed to connect to %s (%u)\n", addr, err);

		printk("Failed to connect to %s %u %s\n", addr, err, bt_hci_err_to_str(err));



		bt_conn_unref(default_conn);

		default_conn = NULL;
@@ -422,7 +422,7 @@ static void disconnected(struct bt_conn *conn, uint8_t reason) 


	(void)bt_addr_le_to_str(bt_conn_get_dst(conn), addr, sizeof(addr));



	printk("Disconnected: %s (reason 0x%02x)\n", addr, reason);

	printk("Disconnected: %s, reason 0x%02x %s\n", addr, reason, bt_hci_err_to_str(reason));



	bt_conn_unref(default_conn);

	default_conn = NULL;
@@ -436,7 +436,7 @@ static void security_changed_cb(struct bt_conn *conn, bt_security_t level, 
	if (err == 0) {

		k_sem_give(&sem_security_updated);

	} else {

		printk("Failed to set security level: %u", err);

		printk("Failed to set security level: %s(%u)", bt_security_err_to_str(err), err);

	}

}

samples/bluetooth/bap_unicast_server/src/main.c

+2 −2
Original line number Diff line number Diff line
@@ -583,7 +583,7 @@ static void connected(struct bt_conn *conn, uint8_t err) 
	bt_addr_le_to_str(bt_conn_get_dst(conn), addr, sizeof(addr));



	if (err != 0) {

		printk("Failed to connect to %s (%u)\n", addr, err);

		printk("Failed to connect to %s %u %s\n", addr, err, bt_hci_err_to_str(err));



		default_conn = NULL;

		return;
@@ -603,7 +603,7 @@ static void disconnected(struct bt_conn *conn, uint8_t reason) 


	bt_addr_le_to_str(bt_conn_get_dst(conn), addr, sizeof(addr));



	printk("Disconnected: %s (reason 0x%02x)\n", addr, reason);

	printk("Disconnected: %s, reason 0x%02x %s\n", addr, reason, bt_hci_err_to_str(reason));



	bt_conn_unref(default_conn);

	default_conn = NULL;

CRA Git | Maintained and supported by SUSTech CRA and CCSE