Add Kingfisher Si4689 supporteel_5.0.2eel_5.0.1eel_5.0.0eel/5.0.2eel/5.0.1eel/5.0.05.0.25.0.15.0.0

Add conditionally compilable support for the Si4689 radio on the
M3ULCB Kingfisher infotainment board.  The codebase has been
refactored to allow multiple radio implementations, and when
Kingfisher support is enabled, the binding will first look for a
USB RTL-SDR adapter, then fallback to the Kingfisher Si4689 if
one is not found.  This allows easily switching to a RTL-SDR
adapter if this initial Kingfisher support encounters issues.

The back end implementation relies on a patched version of the
"si_ctl" utility from Cogent Embedded's Kingfisher BSP changes.
The modifications to it add FM band plan selection and scanning
threshold tweaking for poor radio environments.  Audio output is
achieved by looping the radio's PulseAudio source to the
appropriate sink depending on 4A or non-4A operation.  For 4A
compatibility, the PulseAudio source is created if it does not
exist, which currently is the case due to PulseAudio's udev
module being disabled when 4A is enabled.

Additionally, the FM band plan for Japan has been corrected to go
to 95 MHz, and a README.md file has been added documenting the
optional configuration that can be done via /etc/xdg/AGL.conf for
band plan selection and scanning sensitivity.

Change-Id: I204906fed741d917fc3b8be962deadb4e59989db
Signed-off-by: Scott Murray <scott.murray@konsulko.com>

1 files changed, 396 insertions, 0 deletions

diff --git a/binding/radio_impl_kingfisher.c b/binding/radio_impl_kingfisher.c
new file mode 100644
index 0000000..069ca10
--- /dev/null
+++ b/binding/radio_impl_kingfisher.c
@@ -0,0 +1,396 @@
+/*
+ * Copyright (C) 2017 Konsulko Group
+ *
+ * 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.
+ */
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <stdint.h>
+#include <stdbool.h>
+#include <string.h>
+#include <glib.h>
+#include <fcntl.h>
+#include <sys/stat.h>
+
+#include "radio_impl.h"
+
+#define SI_INIT	"/usr/bin/si_init"
+#define SI_CTL	"/usr/bin/si_ctl"
+
+// Structure to describe FM band plans, all values in Hz.
+typedef struct {
+	char *name;
+	uint32_t min;
+	uint32_t max;
+	uint32_t step;
+} fm_band_plan_t;
+
+static fm_band_plan_t known_fm_band_plans[5] = {
+	{ .name = "US", .min = 87900000, .max = 107900000, .step = 200000 },
+	{ .name = "JP", .min = 76000000, .max = 95000000, .step = 100000 },
+	{ .name = "EU", .min = 87500000, .max = 108000000, .step = 50000 },
+	{ .name = "ITU-1", .min = 87500000, .max = 108000000, .step = 50000 },
+	{ .name = "ITU-2", .min = 87900000, .max = 107900000, .step = 50000 }
+};
+
+static unsigned int bandplan = 0;
+static bool present;
+static bool active;
+static uint32_t current_frequency;
+static int scan_valid_snr_threshold = 128;
+static int scan_valid_rssi_threshold = 128;
+static bool scanning = false;
+
+static void (*freq_callback)(uint32_t, void*);
+static void *freq_callback_data;
+
+static uint32_t kf_get_min_frequency(radio_band_t band);
+static void kf_scan_stop(void);
+
+static int kf_init(void)
+{
+	GKeyFile* conf_file;
+	int conf_file_present = 0;
+	char *value_str;
+	char cmd[128];
+	int rc;
+	char *output_sink;
+	struct stat statbuf;
+
+	if(present)
+		return -1;
+
+	// Check for Cogent's si_init script and si_ctl utility
+	if(stat(SI_INIT, &statbuf) != 0)
+		return -1;
+	if(stat(SI_CTL, &statbuf) != 0)
+		return -1;
+
+	// Load settings from configuration file if it exists
+	conf_file = g_key_file_new();
+	if(conf_file &&
+	   g_key_file_load_from_dirs(conf_file,
+				     "AGL.conf",
+				     (const gchar**) g_get_system_config_dirs(),
+				     NULL,
+				     G_KEY_FILE_KEEP_COMMENTS,
+				     NULL) == TRUE) {
+		conf_file_present = 1;
+
+		// Set band plan if it is specified
+		value_str = g_key_file_get_string(conf_file,
+						  "radio",
+						  "fmbandplan",
+						  NULL);
+		if(value_str) {
+			unsigned int i;
+			for(i = 0;
+			    i < sizeof(known_fm_band_plans) / sizeof(fm_band_plan_t);
+			    i++) {
+				if(!strcasecmp(value_str, known_fm_band_plans[i].name)) {
+					bandplan = i;
+					break;
+				}
+			}
+		}
+	}
+
+	if(conf_file_present) {
+		GError *error = NULL;
+		int n;
+
+		// Allow over-riding scanning parameters just in case a demo
+		// setup needs to do so to work reliably.
+		n = g_key_file_get_integer(conf_file,
+					   "radio",
+					   "scan_valid_snr_threshold",
+					   &error);
+		if(!error) {
+			fprintf(stderr, "Scan valid SNR level set to %d\n", n);
+			scan_valid_snr_threshold = n;
+		}
+
+		error = NULL;
+		n = g_key_file_get_integer(conf_file,
+					   "radio",
+					   "scan_valid_rssi_threshold",
+					   &error);
+		if(!error) {
+			fprintf(stderr, "Scan valid SNR level set to %d\n", n);
+			scan_valid_rssi_threshold = n;
+		}
+
+		g_key_file_free(conf_file);
+	}
+
+	rc = system(SI_INIT);
+	if(rc != 0) {
+		fprintf(stderr, "si_init failed, rc = %d", rc);
+		return -1;
+	}
+
+	fprintf(stderr, "Using FM Bandplan: %s\n", known_fm_band_plans[bandplan].name);
+	current_frequency = kf_get_min_frequency(BAND_FM);
+	sprintf(cmd,
+		"%s /dev/i2c-11 0x65 -b fm -p %s -t %d -u %d -c %d",
+		SI_CTL,
+		known_fm_band_plans[bandplan].name,
+		scan_valid_snr_threshold,
+		scan_valid_rssi_threshold,
+		current_frequency / 1000);
+	rc = system(cmd);
+	if(rc != 0) {
+		fprintf(stderr, "%s failed, rc = %d", SI_CTL, rc);
+		return -1;
+	}
+
+	// Handle 4A disabling PA udev module
+	if(system("pactl list sources short |grep -q alsa_input.radio") != 0) {
+		// Set up radio source
+		if(system("pactl load-module module-alsa-source device=hw:radio,0 name=radio") != 0) {
+			fprintf(stderr, "radio PA source creation failed!\n");
+			return -1;
+		}
+	}
+
+	// Set initial state to muted
+	rc = system("pactl set-source-mute alsa_input.radio 1");
+	if(rc != 0) {
+		fprintf(stderr, "pactl failed, rc = %d", rc);
+		return -1;
+	}
+
+	// Set up loopback to output sink
+	output_sink = getenv("PULSE_SINK");
+	if(!output_sink) {
+		// On non-4A, loopback to the default output sink
+		output_sink = "0";
+	}
+	sprintf(cmd, "pactl load-module module-loopback source=alsa_input.radio sink=%s", output_sink);
+	rc = system(cmd);
+	if(rc != 0) {
+		fprintf(stderr, "pactl failed, rc = %d", rc);
+		return -1;
+	}
+
+	present = true;
+	return 0;
+}
+
+static uint32_t kf_get_frequency(void)
+{
+	return current_frequency;
+}
+
+static void kf_set_frequency(uint32_t frequency)
+{
+	char cmd[128];
+	int rc;
+
+	if(!present)
+		return;
+
+	if(scanning)
+		return;
+
+	if(frequency < known_fm_band_plans[bandplan].min ||
+	   frequency > known_fm_band_plans[bandplan].max)
+		return;
+
+	kf_scan_stop();
+	sprintf(cmd, "%s /dev/i2c-11 0x65 -c %d", SI_CTL, frequency / 1000);
+	rc = system(cmd);
+	if(rc == 0)
+		current_frequency = frequency;
+
+	if(freq_callback)
+		freq_callback(current_frequency, freq_callback_data);
+}
+
+static void kf_set_frequency_callback(radio_freq_callback_t callback,
+				      void *data)
+{
+	freq_callback = callback;
+	freq_callback_data = data;
+}
+
+static radio_band_t kf_get_band(void)
+{
+	return BAND_FM;
+}
+
+static void kf_set_band(radio_band_t band)
+{
+	// We only support FM, so do nothing
+}
+
+static int kf_band_supported(radio_band_t band)
+{
+	if(band == BAND_FM)
+		return 1;
+	return 0;
+}
+
+static uint32_t kf_get_min_frequency(radio_band_t band)
+{
+	return known_fm_band_plans[bandplan].min;
+}
+
+static uint32_t kf_get_max_frequency(radio_band_t band)
+{
+	return known_fm_band_plans[bandplan].max;
+}
+
+static uint32_t kf_get_frequency_step(radio_band_t band)
+{
+	uint32_t ret = 0;
+
+	switch (band) {
+	case BAND_AM:
+		ret = 1000; // 1 kHz
+		break;
+	case BAND_FM:
+		ret = known_fm_band_plans[bandplan].step;
+		break;
+	default:
+		break;
+	}
+	return ret;
+}
+
+static void kf_start(void)
+{
+	int rc;
+
+	if(!present)
+		return;
+
+	if(!active) {
+		rc = system("pactl set-source-mute alsa_input.radio 0");
+		if(rc != 0)
+			fprintf(stderr, "pactl set-source-mute failed!\n");
+		active = true;
+	}
+}
+
+static void kf_stop(void)
+{
+	int rc;
+
+	if(!present)
+		return;
+
+	if(active) {
+		active = false;
+		rc = system("pactl set-source-mute alsa_input.radio 1");
+		if(rc != 0)
+			fprintf(stderr, "pactl set-source-mute failed!\n");
+	}
+}
+
+static void kf_scan_start(radio_scan_direction_t direction,
+			  radio_scan_callback_t callback,
+			  void *data)
+{
+	int rc;
+	char cmd[128];
+	char line[128];
+	uint32_t new_frequency = 0;
+	FILE *fp;
+
+	if(!present)
+		return;
+
+	if(scanning)
+		return;
+
+	scanning = true;
+	sprintf(cmd, "%s /dev/i2c-11 0x65 -l %s", SI_CTL, direction == SCAN_FORWARD ? "up" : "down");
+	fp = popen(cmd, "r");
+	if(fp == NULL) {
+		fprintf(stderr, "Could not run: %s!\n", cmd);
+		return;
+	}
+	// Look for "Frequency:" in output
+	while(fgets(line, 128, fp) != NULL) {
+		if(strncmp("Frequency:", line, 10) == 0) {
+			new_frequency = atoi(line + 10);
+			//fprintf(stderr, "%s: got new_frequency = %d\n", __FUNCTION__, new_frequency);
+			break;
+		}
+	}
+
+	// Make sure si_ctl has finished
+	rc = pclose(fp);
+	if(rc != 0) {
+		// Make sure we reset to original frequency, the Si4689 seems
+		// to auto-mute sometimes on failed scans, this hopefully works
+		// around that.
+		new_frequency = 0;
+	}
+
+	if(new_frequency) {
+		current_frequency = new_frequency * 1000;
+
+		// Push up the new frequency
+		// This is more efficient than calling kf_set_frequency and calling
+		// out to si_ctl again.
+		if(freq_callback)
+			freq_callback(current_frequency, freq_callback_data);
+	} else {
+		// Assume no station found, go back to starting frequency
+		kf_set_frequency(current_frequency);
+	}
+
+	// Push up scan state
+	if(callback)
+		callback(current_frequency, data);
+
+	scanning = false;
+}
+
+static void kf_scan_stop(void)
+{
+	// ATM, it's not straightforward to stop a scan since we're using the si_ctl utility...
+}
+
+static radio_stereo_mode_t kf_get_stereo_mode(void)
+{
+	return STEREO;
+}
+
+static void kf_set_stereo_mode(radio_stereo_mode_t mode)
+{
+	// We only support stereo, so do nothing
+}
+
+radio_impl_ops_t kf_impl_ops = {
+	.name = "Kingfisher Si4689",
+	.init = kf_init,
+	.get_frequency = kf_get_frequency,
+	.set_frequency = kf_set_frequency,
+	.set_frequency_callback = kf_set_frequency_callback,
+	.get_band = kf_get_band,
+	.set_band = kf_set_band,
+	.band_supported = kf_band_supported,
+	.get_min_frequency = kf_get_min_frequency,
+	.get_max_frequency = kf_get_max_frequency,
+	.get_frequency_step = kf_get_frequency_step,
+	.start = kf_start,
+	.stop = kf_stop,
+	.scan_start = kf_scan_start,
+	.scan_stop = kf_scan_stop,
+	.get_stereo_mode = kf_get_stereo_mode,
+	.set_stereo_mode = kf_set_stereo_mode
+};