ish: Trim down the release branchstabilize-wristpin-14469.59.B-ishstabilize-voshyr-14637.B-ishstabilize-quickfix-14695.187.B-ishstabilize-quickfix-14695.124.B-ishstabilize-quickfix-14526.91.B-ishstabilize-14695.85.B-ishstabilize-14695.107.B-ishstabilize-14682.B-ishstabilize-14633.B-ishstabilize-14616.B-ishstabilize-14589.B-ishstabilize-14588.98.B-ishstabilize-14588.14.B-ishstabilize-14588.123.B-ishstabilize-14536.B-ishstabilize-14532.B-ishstabilize-14528.B-ishstabilize-14526.89.B-ishstabilize-14526.84.B-ishstabilize-14526.73.B-ishstabilize-14526.67.B-ishstabilize-14526.57.B-ishstabilize-14498.B-ishstabilize-14496.B-ishstabilize-14477.B-ishstabilize-14469.9.B-ishstabilize-14469.8.B-ishstabilize-14469.58.B-ishstabilize-14469.41.B-ishstabilize-14442.B-ishstabilize-14438.B-ishstabilize-14411.B-ishstabilize-14396.B-ishstabilize-14395.B-ishstabilize-14388.62.B-ishstabilize-14388.61.B-ishstabilize-14388.52.B-ishstabilize-14385.B-ishstabilize-14345.B-ishstabilize-14336.B-ishstabilize-14333.B-ishrelease-R99-14469.B-ishrelease-R98-14388.B-ishrelease-R102-14695.B-ishrelease-R101-14588.B-ishrelease-R100-14526.B-ishfirmware-cherry-14454.B-ishfirmware-brya-14505.B-ishfirmware-brya-14505.71.B-ishfactory-kukui-14374.B-ishfactory-guybrush-14600.B-ishfactory-cherry-14455.B-ishfactory-brya-14517.B-ish

In the interest of making long-term branch maintenance incur as little
technical debt on us as possible, we should not maintain any files on
the branch we are not actually using.

This has the added effect of making it extremely clear when merging CLs
from the main branch when changes have the possibility to affect us.

The follow-on CL adds a convenience script to actually pull updates from
the main branch and generate a CL for the update.

BUG=b:204206272
BRANCH=ish
TEST=make BOARD=arcada_ish && make BOARD=drallion_ish

Signed-off-by: Jack Rosenthal <jrosenth@chromium.org>
Change-Id: I17e4694c38219b5a0823e0a3e55a28d1348f4b18
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3262038
Reviewed-by: Jett Rink <jettrink@chromium.org>
Reviewed-by: Tom Hughes <tomhughes@chromium.org>

1 files changed, 0 insertions, 443 deletions

diff --git a/common/audio_codec_wov.c b/common/audio_codec_wov.c
deleted file mode 100644
index f84e45f342..0000000000
--- a/common/audio_codec_wov.c
+++ /dev/null
@@ -1,443 +0,0 @@
-/*
- * Copyright 2019 The Chromium OS Authors. All rights reserved.
- * Use of this source code is governed by a BSD-style license that can be
- * found in the LICENSE file.
- */
-
-#include "audio_codec.h"
-#include "console.h"
-#include "host_command.h"
-#include "hotword_dsp_api.h"
-#include "sha256.h"
-#include "system.h"
-#include "task.h"
-#include "util.h"
-
-#define CPRINTS(format, args...) cprints(CC_AUDIO_CODEC, format, ## args)
-
-/*
- * To shorten the variable names, or the following code is likely to greater
- * than 80 columns.
- */
-#define AUDIO_BUF_LEN CONFIG_AUDIO_CODEC_WOV_AUDIO_BUF_LEN
-#define LANG_BUF_LEN CONFIG_AUDIO_CODEC_WOV_LANG_BUF_LEN
-
-static uint8_t lang_hash[SHA256_DIGEST_SIZE];
-static uint32_t lang_len;
-
-/*
- * The variables below are shared between host command and WoV task.  This lock
- * is designed to protect them.
- */
-static struct mutex lock;
-
-/*
- * wov_enabled is shared.
- *
- * host command task:
- *   - is the only writer
- *   - no need to lock if read
- */
-static uint8_t wov_enabled;
-
-/*
- * hotword_detected is shared.
- */
-static uint8_t hotword_detected;
-
-/*
- * audio_buf_rp and audio_buf_wp are shared.
- *
- * Note that: sample width is 16-bit.
- *
- * Typical ring-buffer implementation:
- *   If audio_buf_rp == audio_buf_wp, empty.
- *   If (audio_buf_wp + 2) % buf_len == audio_buf_rp, full.
- */
-static uint32_t audio_buf_rp, audio_buf_wp;
-
-static int is_buf_full(void)
-{
-	return ((audio_buf_wp + 2) % AUDIO_BUF_LEN) == audio_buf_rp;
-}
-
-/* only used by host command */
-static uint8_t speech_lib_loaded;
-
-static int check_lang_buf(uint8_t *data, uint32_t len, const uint8_t *hash)
-{
-	/*
-	 * Note: sizeof(struct sha256_ctx) = 200 bytes
-	 * should put into .bss, or stack is likely to overflow (~640 bytes)
-	 */
-	static struct sha256_ctx ctx;
-	uint8_t *digest;
-	int i;
-	uint8_t *p = (uint8_t *)audio_codec_wov_lang_buf_addr;
-
-	SHA256_init(&ctx);
-	SHA256_update(&ctx, data, len);
-	digest = SHA256_final(&ctx);
-
-#ifdef DEBUG_AUDIO_CODEC
-	CPRINTS("data=%08x len=%d", data, len);
-	hexdump(digest, SHA256_DIGEST_SIZE);
-#endif
-
-	if (memcmp(digest, hash, SHA256_DIGEST_SIZE) != 0)
-		return EC_ERROR_UNKNOWN;
-
-	for (i = len; i < LANG_BUF_LEN; ++i)
-		if (p[i])
-			return EC_ERROR_UNKNOWN;
-
-	return EC_SUCCESS;
-}
-
-#ifdef CONFIG_AUDIO_CODEC_CAP_WOV_LANG_SHM
-static enum ec_status wov_set_lang_shm(struct host_cmd_handler_args *args)
-{
-	const struct ec_param_ec_codec_wov *p = args->params;
-	const struct ec_param_ec_codec_wov_set_lang_shm *pp =
-			&p->set_lang_shm_param;
-
-	if (pp->total_len > LANG_BUF_LEN)
-		return EC_RES_INVALID_PARAM;
-	if (wov_enabled)
-		return EC_RES_BUSY;
-
-	if (check_lang_buf((uint8_t *)audio_codec_wov_lang_buf_addr,
-			   pp->total_len, pp->hash) != EC_SUCCESS)
-		return EC_RES_ERROR;
-
-	memcpy(lang_hash, pp->hash, sizeof(lang_hash));
-	lang_len = pp->total_len;
-	speech_lib_loaded = 0;
-
-	args->response_size = 0;
-	return EC_RES_SUCCESS;
-}
-#else
-static enum ec_status wov_set_lang(struct host_cmd_handler_args *args)
-{
-	const struct ec_param_ec_codec_wov *p = args->params;
-	const struct ec_param_ec_codec_wov_set_lang *pp = &p->set_lang_param;
-
-	if (pp->total_len > LANG_BUF_LEN)
-		return EC_RES_INVALID_PARAM;
-	if (pp->offset >= LANG_BUF_LEN)
-		return EC_RES_INVALID_PARAM;
-	if (pp->len > ARRAY_SIZE(pp->buf))
-		return EC_RES_INVALID_PARAM;
-	if (pp->offset + pp->len > pp->total_len)
-		return EC_RES_INVALID_PARAM;
-	if (wov_enabled)
-		return EC_RES_BUSY;
-
-	if (!pp->offset)
-		memset((uint8_t *)audio_codec_wov_lang_buf_addr,
-		       0, LANG_BUF_LEN);
-
-	memcpy((uint8_t *)audio_codec_wov_lang_buf_addr + pp->offset,
-		pp->buf, pp->len);
-
-	if (pp->offset + pp->len == pp->total_len) {
-		if (check_lang_buf((uint8_t *)audio_codec_wov_lang_buf_addr,
-				   pp->total_len, pp->hash) != EC_SUCCESS)
-			return EC_RES_ERROR;
-
-		memcpy(lang_hash, pp->hash, sizeof(lang_hash));
-		lang_len = pp->total_len;
-		speech_lib_loaded = 0;
-	}
-
-	args->response_size = 0;
-	return EC_RES_SUCCESS;
-}
-#endif /* CONFIG_AUDIO_CODEC_CAP_WOV_LANG_SHM */
-
-static enum ec_status wov_get_lang(struct host_cmd_handler_args *args)
-{
-	struct ec_response_ec_codec_wov_get_lang *r = args->response;
-
-	memcpy(r->hash, lang_hash, sizeof(r->hash));
-
-	args->response_size = sizeof(*r);
-	return EC_RES_SUCCESS;
-}
-
-static enum ec_status wov_enable(struct host_cmd_handler_args *args)
-{
-	if (wov_enabled)
-		return EC_RES_BUSY;
-
-	if (audio_codec_wov_enable() != EC_SUCCESS)
-		return EC_RES_ERROR;
-
-	if (!speech_lib_loaded) {
-		if (!GoogleHotwordDspInit(
-				(void *)audio_codec_wov_lang_buf_addr))
-			return EC_RES_ERROR;
-		speech_lib_loaded = 1;
-	} else {
-		GoogleHotwordDspReset();
-	}
-
-	mutex_lock(&lock);
-	wov_enabled = 1;
-	hotword_detected = 0;
-	audio_buf_rp = audio_buf_wp = 0;
-	mutex_unlock(&lock);
-
-#ifdef HAS_TASK_WOV
-	task_wake(TASK_ID_WOV);
-#endif
-
-	args->response_size = 0;
-	return EC_RES_SUCCESS;
-}
-
-static enum ec_status wov_disable(struct host_cmd_handler_args *args)
-{
-	if (!wov_enabled)
-		return EC_RES_BUSY;
-
-	if (audio_codec_wov_disable() != EC_SUCCESS)
-		return EC_RES_ERROR;
-
-	mutex_lock(&lock);
-	wov_enabled = 0;
-	hotword_detected = 0;
-	audio_buf_rp = audio_buf_wp = 0;
-	mutex_unlock(&lock);
-
-	args->response_size = 0;
-	return EC_RES_SUCCESS;
-}
-
-#ifdef CONFIG_AUDIO_CODEC_CAP_WOV_AUDIO_SHM
-static enum ec_status wov_read_audio_shm(struct host_cmd_handler_args *args)
-{
-	struct ec_response_ec_codec_wov_read_audio_shm *r = args->response;
-
-	if (!wov_enabled)
-		return EC_RES_ACCESS_DENIED;
-
-	mutex_lock(&lock);
-	if (!hotword_detected) {
-		mutex_unlock(&lock);
-		return EC_RES_ACCESS_DENIED;
-	}
-
-	r->offset = audio_buf_rp;
-	if (audio_buf_rp <= audio_buf_wp)
-		r->len = audio_buf_wp - audio_buf_rp;
-	else
-		r->len = AUDIO_BUF_LEN - audio_buf_rp;
-
-	audio_buf_rp += r->len;
-	if (audio_buf_rp == AUDIO_BUF_LEN)
-		audio_buf_rp = 0;
-	mutex_unlock(&lock);
-
-#ifdef DEBUG_AUDIO_CODEC
-	if (!r->len)
-		CPRINTS("underrun detected");
-#endif
-
-	args->response_size = sizeof(*r);
-	return EC_RES_SUCCESS;
-}
-#else
-static enum ec_status wov_read_audio(struct host_cmd_handler_args *args)
-{
-	struct ec_response_ec_codec_wov_read_audio *r = args->response;
-	uint8_t *p;
-
-	if (!wov_enabled)
-		return EC_RES_ACCESS_DENIED;
-
-	mutex_lock(&lock);
-	if (!hotword_detected) {
-		mutex_unlock(&lock);
-		return EC_RES_ACCESS_DENIED;
-	}
-
-	if (audio_buf_rp <= audio_buf_wp)
-		r->len = audio_buf_wp - audio_buf_rp;
-	else
-		r->len = AUDIO_BUF_LEN - audio_buf_rp;
-	r->len = MIN(sizeof(r->buf), r->len);
-
-	p = (uint8_t *)audio_codec_wov_audio_buf_addr + audio_buf_rp;
-
-	audio_buf_rp += r->len;
-	if (audio_buf_rp == AUDIO_BUF_LEN)
-		audio_buf_rp = 0;
-	mutex_unlock(&lock);
-
-#ifdef DEBUG_AUDIO_CODEC
-	if (!r->len)
-		CPRINTS("underrun detected");
-#endif
-	/*
-	 * Note: it is possible to copy corrupted audio data if overrun
-	 * happened at the point.  To keep it simple and align to SHM mode,
-	 * we ignore the case if overrun happened.
-	 */
-	memcpy(r->buf, p, r->len);
-
-	args->response_size = sizeof(*r);
-	return EC_RES_SUCCESS;
-}
-#endif /* CONFIG_AUDIO_CODEC_CAP_WOV_AUDIO_SHM */
-
-static enum ec_status (*sub_cmds[])(struct host_cmd_handler_args *) = {
-#ifdef CONFIG_AUDIO_CODEC_CAP_WOV_LANG_SHM
-	[EC_CODEC_WOV_SET_LANG_SHM] = wov_set_lang_shm,
-#else
-	[EC_CODEC_WOV_SET_LANG] = wov_set_lang,
-#endif
-	[EC_CODEC_WOV_GET_LANG] = wov_get_lang,
-	[EC_CODEC_WOV_ENABLE] = wov_enable,
-	[EC_CODEC_WOV_DISABLE] = wov_disable,
-#ifdef CONFIG_AUDIO_CODEC_CAP_WOV_AUDIO_SHM
-	[EC_CODEC_WOV_READ_AUDIO_SHM] = wov_read_audio_shm,
-#else
-	[EC_CODEC_WOV_READ_AUDIO] = wov_read_audio,
-#endif
-};
-
-#ifdef DEBUG_AUDIO_CODEC
-static char *strcmd[] = {
-#ifdef CONFIG_AUDIO_CODEC_CAP_WOV_LANG_SHM
-	[EC_CODEC_WOV_SET_LANG_SHM] = "EC_CODEC_WOV_SET_LANG_SHM",
-#else
-	[EC_CODEC_WOV_SET_LANG] = "EC_CODEC_WOV_SET_LANG",
-#endif
-	[EC_CODEC_WOV_GET_LANG] = "EC_CODEC_WOV_GET_LANG",
-	[EC_CODEC_WOV_ENABLE] = "EC_CODEC_WOV_ENABLE",
-	[EC_CODEC_WOV_DISABLE] = "EC_CODEC_WOV_DISABLE",
-#ifdef CONFIG_AUDIO_CODEC_CAP_WOV_AUDIO_SHM
-	[EC_CODEC_WOV_READ_AUDIO_SHM] = "EC_CODEC_WOV_READ_AUDIO_SHM",
-#else
-	[EC_CODEC_WOV_READ_AUDIO] = "EC_CODEC_WOV_READ_AUDIO",
-#endif
-};
-BUILD_ASSERT(ARRAY_SIZE(sub_cmds) == ARRAY_SIZE(strcmd));
-#endif
-
-static enum ec_status wov_host_command(struct host_cmd_handler_args *args)
-{
-	const struct ec_param_ec_codec_wov *p = args->params;
-
-#ifdef DEBUG_AUDIO_CODEC
-	CPRINTS("WoV subcommand: %s", strcmd[p->cmd]);
-#endif
-
-	if (p->cmd < EC_CODEC_WOV_SUBCMD_COUNT && sub_cmds[p->cmd])
-		return sub_cmds[p->cmd](args);
-
-	return EC_RES_INVALID_PARAM;
-}
-DECLARE_HOST_COMMAND(EC_CMD_EC_CODEC_WOV, wov_host_command, EC_VER_MASK(0));
-
-/*
- * Exported interfaces.
- */
-void audio_codec_wov_task(void *arg)
-{
-	uint32_t n, req;
-	uint8_t *p;
-	int r;
-
-	while (1) {
-		mutex_lock(&lock);
-		if (!wov_enabled) {
-			mutex_unlock(&lock);
-			task_wait_event(-1);
-			continue;
-		}
-
-
-		/* Clear the buffer if full. */
-		if (is_buf_full()) {
-			audio_buf_wp = audio_buf_rp;
-
-#ifdef DEBUG_AUDIO_CODEC
-			if (hotword_detected)
-				CPRINTS("overrun detected");
-#endif
-		}
-
-		/*
-		 * Note: sample width is 16-bit.
-		 *
-		 * The linear ring buffer wastes one sample bytes to
-		 * detect buffer full.
-		 *
-		 * If buffer is empty, maximum req is BUF_LEN - 2.
-		 * If wp > rp, wp can fill to the end of linear buffer.
-		 * If wp < rp, wp can fill up to rp - 2.
-		 */
-		if (audio_buf_wp == audio_buf_rp)
-			req = AUDIO_BUF_LEN - MAX(audio_buf_wp, 2);
-		else if (audio_buf_wp > audio_buf_rp)
-			req = AUDIO_BUF_LEN - audio_buf_wp;
-		else
-			req = audio_buf_rp - audio_buf_wp - 2;
-
-		p = (uint8_t *)audio_codec_wov_audio_buf_addr + audio_buf_wp;
-		mutex_unlock(&lock);
-
-		n = audio_codec_wov_read(p, req);
-		if (n < 0) {
-			CPRINTS("failed to read: %d", n);
-			break;
-		} else if (n == 0) {
-			if (audio_codec_wov_enable_notifier() != EC_SUCCESS) {
-				CPRINTS("failed to enable_notifier");
-				break;
-			}
-
-			task_wait_event(-1);
-			continue;
-		}
-
-		mutex_lock(&lock);
-		audio_buf_wp += n;
-		if (audio_buf_wp == AUDIO_BUF_LEN)
-			audio_buf_wp = 0;
-		mutex_unlock(&lock);
-
-		/*
-		 * GoogleHotwordDspProcess() needs number of samples.  In the
-		 * case, sample is S16_LE.  Thus, n / 2.
-		 */
-		if (!hotword_detected &&
-				GoogleHotwordDspProcess(p, n / 2, &r)) {
-			CPRINTS("hotword detected");
-
-			mutex_lock(&lock);
-			/*
-			 * Note: preserve 40% of buf size for AP to read
-			 * (see go/cros-ec-codec#heading=h.582ga6pgfl2g)
-			 */
-			audio_buf_rp = audio_buf_wp + (AUDIO_BUF_LEN * 2 / 5);
-			if (audio_buf_rp >= AUDIO_BUF_LEN)
-				audio_buf_rp -= AUDIO_BUF_LEN;
-
-			hotword_detected = 1;
-			mutex_unlock(&lock);
-
-			host_set_single_event(EC_HOST_EVENT_WOV);
-		}
-
-		/*
-		 * Reasons to sleep here:
-		 * 1. read the audio data in a fixed pace (10ms)
-		 * 2. yield the processor in case of watchdog thought EC crashed
-		 */
-		task_wait_event(10 * MSEC);
-	}
-}