| /* |
| * Copyright (C) 2018 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. |
| */ |
| |
| package com.android.car; |
| |
| import android.annotation.Nullable; |
| import android.car.drivingstate.CarDrivingStateEvent; |
| import android.car.drivingstate.CarDrivingStateEvent.CarDrivingState; |
| import android.car.drivingstate.CarUxRestrictions; |
| import android.car.drivingstate.ICarDrivingStateChangeListener; |
| import android.car.drivingstate.ICarUxRestrictionsChangeListener; |
| import android.car.drivingstate.ICarUxRestrictionsManager; |
| import android.car.hardware.CarPropertyValue; |
| import android.car.hardware.property.CarPropertyEvent; |
| import android.car.hardware.property.ICarPropertyEventListener; |
| import android.content.Context; |
| import android.hardware.automotive.vehicle.V2_0.VehicleProperty; |
| import android.os.IBinder; |
| import android.os.RemoteException; |
| import android.util.Log; |
| |
| import org.xmlpull.v1.XmlPullParserException; |
| |
| import java.io.IOException; |
| import java.io.PrintWriter; |
| import java.util.ArrayList; |
| import java.util.LinkedList; |
| import java.util.List; |
| |
| /** |
| * A service that listens to current driving state of the vehicle and maps it to the |
| * appropriate UX restrictions for that driving state. |
| */ |
| public class CarUxRestrictionsManagerService extends ICarUxRestrictionsManager.Stub implements |
| CarServiceBase { |
| private static final String TAG = "CarUxR"; |
| private static final boolean DBG = false; |
| private static final int MAX_TRANSITION_LOG_SIZE = 20; |
| private static final int PROPERTY_UPDATE_RATE = 5; // Update rate in Hz |
| private static final float SPEED_NOT_AVAILABLE = -1.0F; |
| private final Context mContext; |
| private final CarDrivingStateService mDrivingStateService; |
| private final CarPropertyService mCarPropertyService; |
| private final CarUxRestrictionsServiceHelper mHelper; |
| // List of clients listening to UX restriction events. |
| private final List<UxRestrictionsClient> mUxRClients = new ArrayList<>(); |
| private CarUxRestrictions mCurrentUxRestrictions; |
| private float mCurrentMovingSpeed; |
| private boolean mFallbackToDefaults; |
| // For dumpsys logging |
| private final LinkedList<Utils.TransitionLog> mTransitionLogs = new LinkedList<>(); |
| |
| |
| public CarUxRestrictionsManagerService(Context context, CarDrivingStateService drvService, |
| CarPropertyService propertyService) { |
| mContext = context; |
| mDrivingStateService = drvService; |
| mCarPropertyService = propertyService; |
| mHelper = new CarUxRestrictionsServiceHelper(mContext, R.xml.car_ux_restrictions_map); |
| // Unrestricted until driving state information is received. During boot up, we don't want |
| // everything to be blocked until data is available from CarPropertyManager. If we start |
| // driving and we don't get speed or gear information, we have bigger problems. |
| mCurrentUxRestrictions = mHelper.createUxRestrictionsEvent(false, |
| CarUxRestrictions.UX_RESTRICTIONS_BASELINE); |
| } |
| |
| @Override |
| public synchronized void init() { |
| try { |
| if (!mHelper.loadUxRestrictionsFromXml()) { |
| Log.e(TAG, "Error reading Ux Restrictions Mapping. Falling back to defaults"); |
| mFallbackToDefaults = true; |
| } |
| } catch (IOException | XmlPullParserException e) { |
| Log.e(TAG, "Exception reading UX restrictions XML mapping", e); |
| mFallbackToDefaults = true; |
| } |
| // subscribe to driving State |
| mDrivingStateService.registerDrivingStateChangeListener( |
| mICarDrivingStateChangeEventListener); |
| // subscribe to property service for speed |
| mCarPropertyService.registerListener(VehicleProperty.PERF_VEHICLE_SPEED, |
| PROPERTY_UPDATE_RATE, mICarPropertyEventListener); |
| initializeUxRestrictions(); |
| } |
| |
| // Update current restrictions by getting the current driving state and speed. |
| private void initializeUxRestrictions() { |
| CarDrivingStateEvent currentDrivingStateEvent = |
| mDrivingStateService.getCurrentDrivingState(); |
| // if we don't have enough information from the CarPropertyService to compute the UX |
| // restrictions, then leave the UX restrictions unchanged from what it was initialized to |
| // in the constructor. |
| if (currentDrivingStateEvent == null || currentDrivingStateEvent.eventValue |
| == CarDrivingStateEvent.DRIVING_STATE_UNKNOWN) { |
| return; |
| } |
| int currentDrivingState = currentDrivingStateEvent.eventValue; |
| Float currentSpeed = getCurrentSpeed(); |
| if (currentSpeed == SPEED_NOT_AVAILABLE) { |
| return; |
| } |
| // At this point the underlying CarPropertyService has provided us enough information to |
| // compute the UX restrictions that could be potentially different from the initial UX |
| // restrictions. |
| handleDispatchUxRestrictions(currentDrivingState, currentSpeed); |
| } |
| |
| private Float getCurrentSpeed() { |
| CarPropertyValue value = mCarPropertyService.getProperty(VehicleProperty.PERF_VEHICLE_SPEED, |
| 0); |
| if (value != null) { |
| return (Float) value.getValue(); |
| } |
| return SPEED_NOT_AVAILABLE; |
| } |
| |
| @Override |
| public synchronized void release() { |
| for (UxRestrictionsClient client : mUxRClients) { |
| client.listenerBinder.unlinkToDeath(client, 0); |
| } |
| mUxRClients.clear(); |
| mDrivingStateService.unregisterDrivingStateChangeListener( |
| mICarDrivingStateChangeEventListener); |
| } |
| |
| // Binder methods |
| |
| /** |
| * Register a {@link ICarUxRestrictionsChangeListener} to be notified for changes to the UX |
| * restrictions |
| * |
| * @param listener listener to register |
| */ |
| @Override |
| public synchronized void registerUxRestrictionsChangeListener( |
| ICarUxRestrictionsChangeListener listener) { |
| if (listener == null) { |
| if (DBG) { |
| Log.e(TAG, "registerUxRestrictionsChangeListener(): listener null"); |
| } |
| throw new IllegalArgumentException("Listener is null"); |
| } |
| // If a new client is registering, create a new DrivingStateClient and add it to the list |
| // of listening clients. |
| UxRestrictionsClient client = findUxRestrictionsClient(listener); |
| if (client == null) { |
| client = new UxRestrictionsClient(listener); |
| try { |
| listener.asBinder().linkToDeath(client, 0); |
| } catch (RemoteException e) { |
| Log.e(TAG, "Cannot link death recipient to binder " + e); |
| } |
| mUxRClients.add(client); |
| } |
| return; |
| } |
| |
| /** |
| * Iterates through the list of registered UX Restrictions clients - |
| * {@link UxRestrictionsClient} and finds if the given client is already registered. |
| * |
| * @param listener Listener to look for. |
| * @return the {@link UxRestrictionsClient} if found, null if not |
| */ |
| @Nullable |
| private UxRestrictionsClient findUxRestrictionsClient( |
| ICarUxRestrictionsChangeListener listener) { |
| IBinder binder = listener.asBinder(); |
| for (UxRestrictionsClient client : mUxRClients) { |
| if (client.isHoldingBinder(binder)) { |
| return client; |
| } |
| } |
| return null; |
| } |
| |
| /** |
| * Unregister the given UX Restrictions listener |
| * |
| * @param listener client to unregister |
| */ |
| @Override |
| public synchronized void unregisterUxRestrictionsChangeListener( |
| ICarUxRestrictionsChangeListener listener) { |
| if (listener == null) { |
| Log.e(TAG, "unregisterUxRestrictionsChangeListener(): listener null"); |
| throw new IllegalArgumentException("Listener is null"); |
| } |
| |
| UxRestrictionsClient client = findUxRestrictionsClient(listener); |
| if (client == null) { |
| Log.e(TAG, "unregisterUxRestrictionsChangeListener(): listener was not previously " |
| + "registered"); |
| return; |
| } |
| listener.asBinder().unlinkToDeath(client, 0); |
| mUxRClients.remove(client); |
| } |
| |
| /** |
| * Gets the current UX restrictions |
| * |
| * @return {@link CarUxRestrictions} for the given event type |
| */ |
| @Override |
| @Nullable |
| public synchronized CarUxRestrictions getCurrentUxRestrictions() { |
| return mCurrentUxRestrictions; |
| } |
| |
| /** |
| * Class that holds onto client related information - listener interface, process that hosts the |
| * binder object etc. |
| * It also registers for death notifications of the host. |
| */ |
| private class UxRestrictionsClient implements IBinder.DeathRecipient { |
| private final IBinder listenerBinder; |
| private final ICarUxRestrictionsChangeListener listener; |
| |
| public UxRestrictionsClient(ICarUxRestrictionsChangeListener l) { |
| listener = l; |
| listenerBinder = l.asBinder(); |
| } |
| |
| @Override |
| public void binderDied() { |
| if (DBG) { |
| Log.d(TAG, "Binder died " + listenerBinder); |
| } |
| listenerBinder.unlinkToDeath(this, 0); |
| synchronized (CarUxRestrictionsManagerService.this) { |
| mUxRClients.remove(this); |
| } |
| } |
| |
| /** |
| * Returns if the given binder object matches to what this client info holds. |
| * Used to check if the listener asking to be registered is already registered. |
| * |
| * @return true if matches, false if not |
| */ |
| public boolean isHoldingBinder(IBinder binder) { |
| return listenerBinder == binder; |
| } |
| |
| /** |
| * Dispatch the event to the listener |
| * |
| * @param event {@link CarUxRestrictions}. |
| */ |
| public void dispatchEventToClients(CarUxRestrictions event) { |
| if (event == null) { |
| return; |
| } |
| try { |
| listener.onUxRestrictionsChanged(event); |
| } catch (RemoteException e) { |
| if (DBG) { |
| Log.d(TAG, "Dispatch to listener failed"); |
| } |
| } |
| } |
| } |
| |
| @Override |
| public void dump(PrintWriter writer) { |
| writer.println( |
| "Requires DO? " + mCurrentUxRestrictions.isRequiresDistractionOptimization()); |
| writer.println("Current UXR: " + mCurrentUxRestrictions.getActiveRestrictions()); |
| mHelper.dump(writer); |
| writer.println("UX Restriction change log:"); |
| for (Utils.TransitionLog tlog : mTransitionLogs) { |
| writer.println(tlog); |
| } |
| } |
| |
| /** |
| * {@link CarDrivingStateEvent} listener registered with the {@link CarDrivingStateService} |
| * for getting driving state change notifications. |
| */ |
| private final ICarDrivingStateChangeListener mICarDrivingStateChangeEventListener = |
| new ICarDrivingStateChangeListener.Stub() { |
| @Override |
| public void onDrivingStateChanged(CarDrivingStateEvent event) { |
| if (DBG) { |
| Log.d(TAG, "Driving State Changed:" + event.eventValue); |
| } |
| handleDrivingStateEvent(event); |
| } |
| }; |
| |
| /** |
| * Handle the driving state change events coming from the {@link CarDrivingStateService}. |
| * Map the driving state to the corresponding UX Restrictions and dispatch the |
| * UX Restriction change to the registered clients. |
| */ |
| private synchronized void handleDrivingStateEvent(CarDrivingStateEvent event) { |
| if (event == null) { |
| return; |
| } |
| int drivingState = event.eventValue; |
| Float speed = getCurrentSpeed(); |
| |
| if (speed != SPEED_NOT_AVAILABLE) { |
| mCurrentMovingSpeed = speed; |
| } else if (drivingState == CarDrivingStateEvent.DRIVING_STATE_PARKED |
| || drivingState == CarDrivingStateEvent.DRIVING_STATE_UNKNOWN) { |
| // If speed is unavailable, but the driving state is parked or unknown, it can still be |
| // handled. |
| if (DBG) { |
| Log.d(TAG, "Speed null when driving state is: " + drivingState); |
| } |
| mCurrentMovingSpeed = 0; |
| } else { |
| // If we get here with driving state != parked or unknown && speed == null, |
| // something is wrong. CarDrivingStateService could not have inferred idling or moving |
| // when speed is not available |
| Log.e(TAG, "Unexpected: Speed null when driving state is: " + drivingState); |
| return; |
| } |
| handleDispatchUxRestrictions(drivingState, mCurrentMovingSpeed); |
| } |
| |
| /** |
| * {@link CarPropertyEvent} listener registered with the {@link CarPropertyService} for getting |
| * speed change notifications. |
| */ |
| private final ICarPropertyEventListener mICarPropertyEventListener = |
| new ICarPropertyEventListener.Stub() { |
| @Override |
| public void onEvent(List<CarPropertyEvent> events) throws RemoteException { |
| for (CarPropertyEvent event : events) { |
| if ((event.getEventType() |
| == CarPropertyEvent.PROPERTY_EVENT_PROPERTY_CHANGE) |
| && (event.getCarPropertyValue().getPropertyId() |
| == VehicleProperty.PERF_VEHICLE_SPEED)) { |
| handleSpeedChange((Float) event.getCarPropertyValue().getValue()); |
| } |
| } |
| } |
| }; |
| |
| private synchronized void handleSpeedChange(float newSpeed) { |
| if (newSpeed == mCurrentMovingSpeed) { |
| // Ignore if speed hasn't changed |
| return; |
| } |
| int currentDrivingState = mDrivingStateService.getCurrentDrivingState().eventValue; |
| if (currentDrivingState != CarDrivingStateEvent.DRIVING_STATE_MOVING) { |
| // Ignore speed changes if the vehicle is not moving |
| return; |
| } |
| mCurrentMovingSpeed = newSpeed; |
| handleDispatchUxRestrictions(currentDrivingState, newSpeed); |
| } |
| |
| /** |
| * Handle dispatching UX restrictions change. |
| * |
| * @param currentDrivingState driving state of the vehicle |
| * @param speed speed of the vehicle |
| */ |
| private synchronized void handleDispatchUxRestrictions(@CarDrivingState int currentDrivingState, |
| float speed) { |
| CarUxRestrictions uxRestrictions; |
| // Get UX restrictions from the parsed configuration XML or fall back to defaults if not |
| // available. |
| if (mFallbackToDefaults) { |
| uxRestrictions = getDefaultRestrictions(currentDrivingState); |
| } else { |
| uxRestrictions = mHelper.getUxRestrictions(currentDrivingState, speed); |
| } |
| |
| if (DBG) { |
| Log.d(TAG, String.format("DO old->new: %b -> %b", |
| mCurrentUxRestrictions.isRequiresDistractionOptimization(), |
| uxRestrictions.isRequiresDistractionOptimization())); |
| Log.d(TAG, String.format("UxR old->new: 0x%x -> 0x%x", |
| mCurrentUxRestrictions.getActiveRestrictions(), |
| uxRestrictions.getActiveRestrictions())); |
| } |
| |
| if (mCurrentUxRestrictions.isSameRestrictions(uxRestrictions)) { |
| // Ignore dispatching if the restrictions has not changed. |
| return; |
| } |
| // for dumpsys logging |
| StringBuilder extraInfo = new StringBuilder(); |
| extraInfo.append( |
| mCurrentUxRestrictions.isRequiresDistractionOptimization() ? "DO -> " |
| : "No DO -> "); |
| extraInfo.append( |
| uxRestrictions.isRequiresDistractionOptimization() ? "DO" : "No DO"); |
| addTransitionLog(TAG, mCurrentUxRestrictions.getActiveRestrictions(), |
| uxRestrictions.getActiveRestrictions(), System.currentTimeMillis(), |
| extraInfo.toString()); |
| |
| mCurrentUxRestrictions = uxRestrictions; |
| if (DBG) { |
| Log.d(TAG, "dispatching to " + mUxRClients.size() + " clients"); |
| } |
| for (UxRestrictionsClient client : mUxRClients) { |
| client.dispatchEventToClients(uxRestrictions); |
| } |
| } |
| |
| private CarUxRestrictions getDefaultRestrictions(@CarDrivingState int drivingState) { |
| int restrictions; |
| boolean requiresOpt = false; |
| switch (drivingState) { |
| case CarDrivingStateEvent.DRIVING_STATE_PARKED: |
| restrictions = CarUxRestrictions.UX_RESTRICTIONS_BASELINE; |
| break; |
| case CarDrivingStateEvent.DRIVING_STATE_IDLING: |
| restrictions = CarUxRestrictions.UX_RESTRICTIONS_BASELINE; |
| requiresOpt = true; |
| break; |
| case CarDrivingStateEvent.DRIVING_STATE_MOVING: |
| default: |
| restrictions = CarUxRestrictions.UX_RESTRICTIONS_FULLY_RESTRICTED; |
| requiresOpt = true; |
| } |
| return mHelper.createUxRestrictionsEvent(requiresOpt, restrictions); |
| } |
| |
| private void addTransitionLog(String name, int from, int to, long timestamp, String extra) { |
| if (mTransitionLogs.size() >= MAX_TRANSITION_LOG_SIZE) { |
| mTransitionLogs.remove(); |
| } |
| |
| Utils.TransitionLog tLog = new Utils.TransitionLog(name, from, to, timestamp, extra); |
| mTransitionLogs.add(tLog); |
| } |
| |
| } |