Add low power processor offload manager with socket hal shim (ea59bfab) · Commits · e / os / android_packages_modules_Bluetooth

system/gd/Android.bp

+4 −0

Original line number	Diff line number	Diff line
		@@ -87,6 +87,7 @@ cc_defaults {
		srcs: [
		":BluetoothHalSources_hci_host",
		":BluetoothHalSources_ranging_host",
		":BluetoothHalSources_socket_host",
		":BluetoothOsSources_host",
		":BluetoothSyspropsSources",
		],
		@@ -95,6 +96,7 @@ cc_defaults {
		srcs: [
		":BluetoothHalSources_hci_android_hidl",
		":BluetoothHalSources_ranging_android",
		":BluetoothHalSources_socket_android",
		":BluetoothOsSources_android",
		],
		shared_libs: [
		@@ -117,6 +119,7 @@ cc_defaults {
		whole_static_libs: [
		"android.hardware.bluetooth-V1-ndk",
		"android.hardware.bluetooth.ranging-V2-ndk",
		"android.hardware.bluetooth.socket-V1-ndk",
		],
		},
		},
		@@ -125,6 +128,7 @@ cc_defaults {
		":BluetoothDumpsysSources",
		":BluetoothHalSources",
		":BluetoothHciSources",
		":BluetoothLppOffloadSources",
		":BluetoothMetricsSources",
		":BluetoothNeighborSources",
		":BluetoothOsSources",

system/gd/BUILD.gn

+1 −0

Original line number	Diff line number	Diff line
		@@ -69,6 +69,7 @@ static_library("libbluetooth_gd") {
		"//bt/system/gd/hal:BluetoothHalSources",
		"//bt/system/gd/hal:BluetoothHalSources_hci_host",
		"//bt/system/gd/hal:BluetoothHalSources_ranging_host",
		"//bt/system/gd/hal:BluetoothHalSources_socket_host",
		"//bt/system/gd/metrics:BluetoothMetricsSources",
		"//bt/system/gd/neighbor:BluetoothNeighborSources",
		"//bt/system/gd/shim:BluetoothShimSources",

system/gd/hal/Android.bp

+14 −0

Original line number	Diff line number	Diff line
		@@ -42,6 +42,20 @@ filegroup {
		],
		}

		filegroup {
		name: "BluetoothHalSources_socket_android",
		srcs: [
		"socket_hal_android.cc",
		],
		}

		filegroup {
		name: "BluetoothHalSources_socket_host",
		srcs: [
		"socket_hal_host.cc",
		],
		}

		filegroup {
		name: "BluetoothHalSources_hci_android_hidl",
		srcs: [

system/gd/hal/BUILD.gn

+9 −0

Original line number	Diff line number	Diff line
		@@ -53,3 +53,12 @@ source_set("BluetoothHalSources_ranging_host") {
		configs += [ "//bt/system/gd:gd_defaults" ]
		deps = [ "//bt/system/gd:gd_default_deps" ]
		}

		source_set("BluetoothHalSources_socket_host") {
		sources = [
		"socket_hal_host.cc",
		]

		configs += [ "//bt/system/gd:gd_defaults" ]
		deps = [ "//bt/system/gd:gd_default_deps" ]
		}

system/gd/hal/socket_hal.h

0 → 100644

+174 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright 2024 The Android Open Source Project
		*
		* Licensed under the Apache License, Version 2.0 (the "License");
		* you may not use this file except in compliance with the License.
		* You may obtain a copy of the License at
		*
		* http://www.apache.org/licenses/LICENSE-2.0
		*
		* Unless required by applicable law or agreed to in writing, software
		* distributed under the License is distributed on an "AS IS" BASIS,
		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
		* See the License for the specific language governing permissions and
		* limitations under the License.
		*/

		#pragma once

		#include <cstdint>

		#include "module.h"

		namespace bluetooth::hal {

		enum SocketStatus {
		SUCCESS = 0,
		FAILURE,
		};

		struct EndpointInfo {
		// The ID of the Hub to which the end point belongs for hardware offload data path.
		uint64_t hub_id;

		// The ID of the Hub endpoint for hardware offload data path.
		uint64_t endpoint_id;
		};

		struct LeCocCapabilities {
		// Maximum number of LE COC sockets supported. If not supported, the value must be zero.
		int number_of_supported_sockets;

		// Local Maximum Transmission Unit size in octets.
		uint16_t mtu;
		};

		struct SocketCapabilities {
		LeCocCapabilities le_coc_capabilities;
		};

		struct LeCocChannelInfo {
		// L2cap local channel ID.
		uint16_t local_cid;

		// L2cap remote channel ID.
		uint16_t remote_cid;

		// PSM for L2CAP LE CoC.
		uint16_t psm;

		// Local Maximum Transmission Unit for LE COC specifying the maximum SDU size in bytes that the
		// local L2CAP layer can receive.
		uint16_t local_mtu;

		// Remote Maximum Transmission Unit for LE COC specifying the maximum SDU size in bytes that the
		// remote L2CAP layer can receive.
		uint16_t remote_mtu;

		// Local Maximum PDU payload Size in bytes that the local L2CAP layer can receive.
		uint16_t local_mps;

		// Remote Maximum PDU payload Size in bytes that the remote L2CAP layer can receive.
		uint16_t remote_mps;

		// Protocol initial credits at Rx path.
		uint16_t initial_rx_credits;

		// Protocol initial credits at Tx path.
		uint16_t initial_tx_credits;
		};

		struct SocketContext {
		// Identifier assigned to the socket by the host stack when the socket is connected.
		uint64_t socket_id;

		// Descriptive socket name provided by the host app when it created this socket.
		std::string name;

		// ACL connection handle for the socket.
		uint16_t acl_connection_handle;

		// Channel information of different protocol used for the socket.
		std::variant<LeCocChannelInfo> channel_info;

		// Endpoint information.
		EndpointInfo endpoint_info;
		};

		/**
		* SocketHalCallback provides an interface for receiving asynchronous events from socket HAL.
		* Implementations of this class can be registered with the stack to receive these callbacks.
		*
		* Callback methods in this interface are invoked from the binder thread. This means that
		* implementations must be thread-safe and handle any necessary synchronization to avoid race
		* conditions or other concurrency issues. The callee is solely responsible for ensuring thread
		* safety within the callback methods.
		*/
		class SocketHalCallback {
		public:
		virtual ~SocketHalCallback() = default;

		/**
		* Invoked when IBluetoothSocket.opened() has been completed.
		*
		* @param socket_id Identifier assigned to the socket by the host stack
		* @param status Status indicating success or failure
		*/
		virtual void SocketOpenedComplete(uint64_t socket_id, SocketStatus status) const = 0;

		/**
		* Invoked when offload app or stack requests host stack to close the socket.
		*
		* @param socket_id Identifier assigned to the socket by the host stack
		*/
		virtual void SocketClose(uint64_t socket_id) const = 0;
		};

		/**
		* SocketHal provides an interface to low-power processors, enabling Bluetooth Offload Socket
		* functionality.
		*
		* Bluetooth Offload Socket allows the transfer of channel information from an established
		* BluetoothSocket to a low-power processor. This enables the offload stack on the low-power
		* processor to handle packet reception, processing, and transmission independently. This offloading
		* process prevents the need to wake the main application processor, improving power efficiency.
		*/
		class SocketHal : public ::bluetooth::Module {
		public:
		static const ModuleFactory Factory;

		virtual ~SocketHal() = default;

		/**
		* Registers a socket hal callback function to receive asynchronous events from socket HAL.
		*
		* @param callback A pointer to the callback function. Must not be nullptr and must have static
		* lifetime.
		* @return True if the callback was successfully registered, false otherwise.
		*/
		virtual bool RegisterCallback(hal::SocketHalCallback const* callback) = 0;

		/**
		* Retrieves the supported offloaded socket capabilities.
		*
		* @return Supported socket capabilities
		*/
		virtual hal::SocketCapabilities GetSocketCapabilities() const = 0;

		/**
		* Notifies the socket HAL that the socket has been opened.
		*
		* @param context Socket context including socket ID, channel, hub, and endpoint info
		* @return Result of calling this method
		*/
		virtual bool Opened(const hal::SocketContext& context) const = 0;

		/**
		* Notifies the socket HAL that the socket has been closed.
		*
		* @param socket_id Identifier assigned to the socket by the host stack
		*/
		virtual void Closed(uint64_t socket_id) const = 0;
		};

		} // namespace bluetooth::hal