rockbox/uisimulator/common/sim_tasks.c
Aidan MacDonald 85232fadbb simulator: fix off by one error in USB ack calculations
The sim's printout of the number of expected USB acks was off by one.
Since the sim queue is not registered for broadcasts, it will not
receive an ack message and does not need to account for itself when
determining the number of acks to expect, unlike the USB code.

Change-Id: I6715039c05c1ea95099716c5251d401e37f5b085
2022-05-22 15:34:42 +01:00

270 lines
7.4 KiB
C

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2009 by Jens Arnold
* Copyright (C) 2011 by Thomas Martitz
*
* Rockbox simulator specific tasks
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
****************************************************************************/
#include "config.h"
#include "kernel.h"
#include "screendump.h"
#include "thread.h"
#include "debug.h"
#include "usb.h"
#include "mv.h"
#include "ata_idle_notify.h"
#ifdef WIN32
#include <windows.h>
#endif
static void sim_thread(void);
static long sim_thread_stack[DEFAULT_STACK_SIZE/sizeof(long)];
/* stack isn't actually used in the sim */
static const char sim_thread_name[] = "sim";
static struct event_queue sim_queue;
/* possible events for the sim thread */
enum {
SIM_SCREENDUMP,
SIM_USB_INSERTED,
SIM_USB_EXTRACTED,
#ifdef HAVE_MULTIDRIVE
SIM_EXT_INSERTED,
SIM_EXT_EXTRACTED,
#endif
};
#ifdef HAVE_MULTIDRIVE
extern void sim_ext_extracted(int drive);
#endif
void sim_thread(void)
{
struct queue_event ev;
long last_broadcast_tick = current_tick;
int num_acks_to_expect = 0;
while (1)
{
queue_wait_w_tmo(&sim_queue, &ev, 5*HZ);
switch(ev.id)
{
case SYS_TIMEOUT:
call_storage_idle_notifys(false);
break;
case SIM_SCREENDUMP:
screen_dump();
#ifdef HAVE_REMOTE_LCD
remote_screen_dump();
#endif
break;
case SIM_USB_INSERTED:
/* from firmware/usb.c: */
/* Tell all threads that they have to back off the storage.
We subtract one for our own thread. Expect an ACK for every
listener for each broadcast they received. If it has been too
long, the user might have entered a screen that didn't ACK
when inserting the cable, such as a debugging screen. In that
case, reset the count or else USB would be locked out until
rebooting because it most likely won't ever come. Simply
resetting to the most recent broadcast count is racy. */
if(TIME_AFTER(current_tick, last_broadcast_tick + HZ*5))
{
num_acks_to_expect = 0;
last_broadcast_tick = current_tick;
}
/* NOTE: Unlike the USB code, we do not subtract one here
* because the sim_queue is not registered for broadcasts! */
num_acks_to_expect += queue_broadcast(SYS_USB_CONNECTED, 0);
DEBUGF("USB inserted. Waiting for %d acks...\n",
num_acks_to_expect);
break;
case SYS_USB_CONNECTED_ACK:
if(num_acks_to_expect > 0 && --num_acks_to_expect == 0)
{
DEBUGF("All threads have acknowledged the connect.\n");
}
else
{
DEBUGF("usb: got ack, %d to go...\n",
num_acks_to_expect);
}
break;
case SIM_USB_EXTRACTED:
/* in usb.c, this is only done for exclusive storage
* do it here anyway but don't depend on the acks */
queue_broadcast(SYS_USB_DISCONNECTED, 0);
break;
#ifdef HAVE_MULTIDRIVE
case SIM_EXT_INSERTED:
case SIM_EXT_EXTRACTED:
sim_ext_extracted(ev.data);
queue_broadcast(ev.id == SIM_EXT_INSERTED ?
SYS_HOTSWAP_INSERTED : SYS_HOTSWAP_EXTRACTED, 0);
sleep(HZ/20);
queue_broadcast(SYS_FS_CHANGED, 0);
break;
#endif /* HAVE_MULTIDRIVE */
default:
DEBUGF("sim_tasks: unhandled event: %ld\n", ev.id);
break;
}
}
}
void sim_tasks_init(void)
{
queue_init(&sim_queue, false);
create_thread(sim_thread, sim_thread_stack, sizeof(sim_thread_stack), 0,
sim_thread_name IF_PRIO(,PRIORITY_BACKGROUND) IF_COP(,CPU));
}
void sim_trigger_screendump(void)
{
queue_post(&sim_queue, SIM_SCREENDUMP, 0);
}
static bool is_usb_inserted;
void sim_trigger_usb(bool inserted)
{
int usbmode = -1;
if (inserted)
{
send_event(SYS_EVENT_USB_INSERTED, &usbmode);
queue_post(&sim_queue, SIM_USB_INSERTED, 0);
}
else
{
send_event(SYS_EVENT_USB_EXTRACTED, NULL);
queue_post(&sim_queue, SIM_USB_EXTRACTED, 0);
}
is_usb_inserted = inserted;
}
int usb_detect(void)
{
return is_usb_inserted ? USB_INSERTED : USB_EXTRACTED;
}
void usb_init(void)
{
}
void usb_start_monitoring(void)
{
}
void usb_acknowledge(long id)
{
queue_post(&sim_queue, id, 0);
}
void usb_wait_for_disconnect(struct event_queue *q)
{
struct queue_event ev;
/* Don't return until we get SYS_USB_DISCONNECTED */
while(1)
{
queue_wait(q, &ev);
if(ev.id == SYS_USB_DISCONNECTED)
return;
}
}
#ifdef HAVE_MULTIDRIVE
static bool is_ext_inserted;
void sim_trigger_external(bool inserted)
{
is_ext_inserted = inserted;
int drive = 1; /* Can do others! */
if (inserted)
queue_post(&sim_queue, SIM_EXT_INSERTED, drive);
else
queue_post(&sim_queue, SIM_EXT_EXTRACTED, drive);
}
bool hostfs_present(int drive)
{
return drive > 0 ? is_ext_inserted : true;
}
bool hostfs_removable(int drive)
{
return drive > 0;
}
#ifdef HAVE_MULTIVOLUME
bool volume_removable(int volume)
{
/* volume == drive for now */
return hostfs_removable(volume);
}
bool volume_present(int volume)
{
/* volume == drive for now */
return hostfs_present(volume);
}
int volume_drive(int volume)
{
/* volume == drive for now */
return volume;
}
#endif /* HAVE_MULTIVOLUME */
#if (CONFIG_STORAGE & STORAGE_MMC)
bool mmc_touched(void)
{
return hostfs_present(1);
}
#endif
#ifdef CONFIG_STORAGE_MULTI
int hostfs_driver_type(int drive)
{
/* Hack alert */
#if (CONFIG_STORAGE & STORAGE_ATA)
#define SIMEXT1_TYPE_NUM STORAGE_ATA_NUM
#elif (CONFIG_STORAGE & STORAGE_SD)
#define SIMEXT1_TYPE_NUM STORAGE_SD_NUM
#elif (CONFIG_STORAGE & STORAGE_MMC)
#define SIMEXT1_TYPE_NUM STORAGE_MMC_NUM
#elif (CONFIG_STORAGE & STORAGE_NAND)
#define SIMEXT1_TYPE_NUM STORAGE_NAND_NUM
#elif (CONFIG_STORAGE & STORAGE_RAMDISK)
#define SIMEXT1_TYPE_NUM STORAGE_RAMDISK_NUM
#elif (CONFIG_STORAGE & STORAGE_USB)
#define SIMEXT1_TYPE_NUM STORAGE_USB_NUM
#else
#error Unknown storage driver
#endif /* CONFIG_STORAGE */
return drive > 0 ? SIMEXT1_TYPE_NUM : STORAGE_HOSTFS_NUM;
}
#endif /* CONFIG_STORAGE_MULTI */
#endif /* CONFIG_STORAGE & STORAGE_MMC */