add ensoniq, usb hal and match volume and ramp name with HLB audio role

2 files changed, 213 insertions, 0 deletions

diff --git a/Ensoniq/CMakeLists.txt b/Ensoniq/CMakeLists.txt
new file mode 100644
index 0000000..ce357fe
--- /dev/null
+++ b/Ensoniq/CMakeLists.txt
@@ -0,0 +1,39 @@
+###########################################################################
+# Copyright 2015, 2016, 2017 IoT.bzh
+#
+# author: Fulup Ar Foll <fulup@iot.bzh>
+#
+# 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.
+###########################################################################
+
+
+# Add target to project dependency list
+PROJECT_TARGET_ADD(hal-ensoniq)
+
+    # Define project Targets
+    ADD_LIBRARY(${TARGET_NAME} MODULE EnsoniqHAL.c)
+
+    # Binder exposes a unique public entry point
+    SET_TARGET_PROPERTIES(${TARGET_NAME} PROPERTIES
+	PREFIX "afb-"
+        LABELS "BINDING"
+	LINK_FLAGS  ${BINDINGS_LINK_FLAG}
+        OUTPUT_NAME ${TARGET_NAME}
+    )
+
+    # Library dependencies (include updates automatically)
+    TARGET_LINK_LIBRARIES(${TARGET_NAME}
+        hal-utilities-4a
+        ${link_libraries}
+    )
+
diff --git a/Ensoniq/EnsoniqHAL.c b/Ensoniq/EnsoniqHAL.c
new file mode 100644
index 0000000..c91fc75
--- /dev/null
+++ b/Ensoniq/EnsoniqHAL.c
@@ -0,0 +1,174 @@
+/*
+ * Copyright (C) 2016 "IoT.bzh"
+ * Author Fulup Ar Foll <fulup@iot.bzh>
+ *
+ * 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.
+ *
+ *
+ * To find out which control your sound card uses
+ *  aplay -l  # Check sndcard name name in between []
+ *  amixer -D hw:xx controls # get supported controls
+ *  amixer -D "hw:3" cget numid=xx  # get control settings
+ *
+ */
+#define _GNU_SOURCE
+#include "hal-interface.h"
+
+// Define few private tag for not standard functions
+#define PCM_Volume_Multimedia 1000
+#define PCM_Volume_Navigation 1001
+#define PCM_Volume_Emergency      1002
+
+// Default Values for MasterVolume Ramping
+STATIC halVolRampT volRampMaster= {
+    .mode    = RAMP_VOL_NORMAL,
+    .slave   = Master_Playback_Volume,
+    .delay   = 100*1000, // ramping delay in us
+    .stepDown=1,
+    .stepUp  =1,
+};
+
+//Solvol Ramping Value can be customize by Audio Role and Hardwar card
+STATIC halVolRampT volRampGuidance= {
+    .slave   = Guidance_Playback_Volume,
+    .delay   = 50*1000, // ramping delay in us
+    .stepDown= 2,
+    .stepUp  = 4,
+};
+
+STATIC halVolRampT volRampCommunication= {
+    .slave   = Communication_Playback_Volume,
+    .delay   = 50*1000, // ramping delay in us
+    .stepDown= 6,
+    .stepUp  = 4,
+};
+
+STATIC halVolRampT volRampEntertainment= {
+    .slave   = Entertainment_Playback_Volume,
+    .delay   = 100*1000, // ramping delay in us
+    .stepDown= 4,
+    .stepUp  = 2,
+};
+
+STATIC halVolRampT volRampNotification= {
+    .slave   = Notification_Playback_Volume,
+    .delay   = 50*1000, // ramping delay in us
+    .stepDown= 6,
+    .stepUp  = 4,
+};
+
+STATIC halVolRampT volRampWarning= {
+    .slave   = Warning_Playback_Volume,
+    .delay   = 10*1000, // ramping delay in us
+    .stepDown= 6,
+    .stepUp  = 10,
+};
+
+STATIC halVolRampT volRampSystem= {
+    .slave   = System_Playback_Volume,
+    .delay   = 20*100, // ramping delay in us
+    .stepDown= 6,
+    .stepUp  = 10,
+};
+
+
+STATIC halVolRampT volRampStartup= {
+    .slave   = Startup_Playback_Volume,
+    .delay   = 20*100, // ramping delay in us
+    .stepDown= 6,
+    .stepUp  = 10,
+};
+
+STATIC halVolRampT volRampShutdown= {
+    .slave   = Shutdown_Playback_Volume,
+    .delay   = 20*100, // ramping delay in us
+    .stepDown= 6,
+    .stepUp  = 10,
+};
+
+
+
+// Map HAL hight sndctl with Alsa numid and optionally with a custom callback for non Alsa supported functionalities.
+STATIC alsaHalMapT  alsaHalMap[]= {  
+  { .tag=Master_Playback_Volume, .ctl={.name="Master Playback Volume", .value=100 } },
+  { .tag=PCM_Playback_Volume     , .ctl={.name="PCM Playback Volume", .value=100 } },
+  { .tag=PCM_Playback_Switch     , .ctl={.name="Master Playback Switch" } },
+  { .tag=Capture_Volume          , .ctl={.name="Capture Volume"  } },
+
+  // Sound card does not have hardware volume ramping
+  { .tag=Master_Playback_Ramp   , .cb={.callback=volumeRamp, .handle=&volRampMaster}, .info="Master Playback Volume Ramp",
+    .ctl={.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER, .count=1, .minval=0, .maxval=100, .step=1, .name="Master_Ramp"}
+  },
+
+  // Implement Rampup Volume for Virtual Channels (0-100)
+  { .tag=Guidance_Playback_Ramp, .cb={.callback=volumeRamp, .handle=&volRampGuidance}, .info="RampUp Guidance Volume",
+    .ctl={.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER,.name="Guidance_Ramp", .minval=0, .maxval=100, .step=1, .value=80 }
+  },
+  { .tag=Entertainment_Playback_Ramp, .cb={.callback=volumeRamp, .handle=&volRampEntertainment}, .info="Rampup Entertainment Volume",
+    .ctl={.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER,.name="Entertainment_Ramp", .minval=0, .maxval=100, .step=1, .value=80 }
+  },
+  { .tag=Notification_Playback_Ramp, .cb={.callback=volumeRamp, .handle=&volRampNotification}, .info="Ramp-up Notification Volume",
+    .ctl={.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER, .name="Notification_Ramp", .minval=0, .maxval=100, .step=1, .value=80 }
+  },
+  { .tag=Communication_Playback_Ramp, .cb={.callback=volumeRamp, .handle=&volRampCommunication}, .info="RampUp Communication Volume",
+    .ctl={.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER,.name="Communication_Ramp", .minval=0, .maxval=100, .step=1, .value=80 }
+  },
+  { .tag=Warning_Playback_Ramp, .cb={.callback=volumeRamp, .handle=&volRampWarning}, .info="Ramp-up Warning Volume",
+    .ctl={.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER, .name="Warning_Ramp", .minval=0, .maxval=100, .step=1, .value=80 }
+  },
+
+  { .tag=System_Playback_Ramp, .cb={.callback=volumeRamp, .handle=&volRampSystem}, .info="Ramp-up System Volume",
+    .ctl={.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER, .name="System_Ramp", .minval=0, .maxval=100, .step=1, .value=80 }
+  },
+  { .tag=Startup_Playback_Ramp, .cb={.callback=volumeRamp, .handle=&volRampStartup}, .info="Ramp-up Startup Volume",
+    .ctl={.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER, .name="Statup_Ramp", .minval=0, .maxval=100, .step=1, .value=80 }
+  },
+  { .tag=Shutdown_Playback_Ramp, .cb={.callback=volumeRamp, .handle=&volRampShutdown}, .info="Ramp-up Shutdown Volume",
+    .ctl={.numid=CTL_AUTO, .type=SND_CTL_ELEM_TYPE_INTEGER, .name="Shutdown_Ramp", .minval=0, .maxval=100, .step=1, .value=80 }
+  },
+
+  // Bind with existing ones created by ALSA configuration (and linked to softvol) [0-255]
+  { .tag=Guidance_Playback_Volume      , .ctl={.name="Guidance_Volume", .minval=0, .maxval=255, .step=1, .value=204 } },
+  { .tag=Entertainment_Playback_Volume , .ctl={.name="Entertainment_Volume", .minval=0, .maxval=255, .step=1, .value=204 } },
+  { .tag=Notification_Playback_Volume  , .ctl={.name="Notification_Volume", .minval=0, .maxval=255, .step=1, .value=204 } },
+  { .tag=Communication_Playback_Volume , .ctl={.name="Communications_Volume", .minval=0, .maxval=255, .step=1, .value=204 } },
+  { .tag=Warning_Playback_Volume       , .ctl={.name="Warning_Volume", .minval=0, .maxval=255, .step=1, .value=204 } },
+  { .tag=System_Playback_Volume        , .ctl={.name="System_Volume", .minval=0, .maxval=255, .step=1, .value=204 } },
+  { .tag=Startup_Playback_Volume       , .ctl={.name="Startup_Volume", .minval=0, .maxval=255, .step=1, .value=204 } },
+  { .tag=Shutdown_Playback_Volume      , .ctl={.name="Shutdown_Volume", .minval=0, .maxval=255, .step=1, .value=204 } },
+  // Could have similar controls for input  side
+
+  { .tag=EndHalCrlTag}  /* marker for end of the array */
+} ;
+
+// HAL sound card mapping info
+STATIC alsaHalSndCardT alsaHalSndCard = {
+    .name = "Ensoniq AudioPCI", //  WARNING: name MUST match with 'aplay -l'
+    .info = "Hardware Abstraction Layer for IntelHDA sound card",
+    .ctls = alsaHalMap,
+};
+
+STATIC int sndServiceInit() {
+    int err;
+    AFB_DEBUG("Ensoniq HAL Binding Init");
+    err = halServiceInit(afbBindingV2.api, &alsaHalSndCard);
+    return err;
+}
+
+// API prefix should be unique for each snd card
+PUBLIC const struct afb_binding_v2 afbBindingV2 = {
+    .api = "ensoniq",
+    .init = sndServiceInit,
+    .verbs = halServiceApi,
+    .onevent = halServiceEvent,
+};