nuttx-apps/system/usbmsc/usbmsc_main.c
YAMAMOTO Takashi faba0249c1 Include malloc.h instead of stdlib.h for mallinfo()
Adapt to the change in the main repo.

mallinfo is meant to be API compatible with Linux,
where it's provided by malloc.h.

(I think the API actually originated with System V. I don't
remember how it was there though. Anyway, I guess the
compatibility with Linux is more important than System V
these days.)
2020-06-15 07:21:52 -06:00

627 lines
18 KiB
C

/****************************************************************************
* system/usbmsc/usbmsc_main.c
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you 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.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <sys/types.h>
#include <sys/boardctl.h>
#include <stdio.h>
#include <stdbool.h>
#include <stdlib.h>
#include <malloc.h>
#include <unistd.h>
#include <debug.h>
#include <nuttx/usb/usbdev.h>
#include <nuttx/usb/usbmsc.h>
#include <nuttx/usb/usbdev_trace.h>
#include "usbmsc.h"
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
#ifdef CONFIG_SYSTEM_USBMSC_TRACEINIT
# define TRACE_INIT_BITS (TRACE_INIT_BIT)
#else
# define TRACE_INIT_BITS (0)
#endif
#define TRACE_ERROR_BITS (TRACE_DEVERROR_BIT|TRACE_CLSERROR_BIT)
#ifdef CONFIG_SYSTEM_USBMSC_TRACECLASS
# define TRACE_CLASS_BITS (TRACE_CLASS_BIT|TRACE_CLASSAPI_BIT|TRACE_CLASSSTATE_BIT)
#else
# define TRACE_CLASS_BITS (0)
#endif
#ifdef CONFIG_SYSTEM_USBMSC_TRACETRANSFERS
# define TRACE_TRANSFER_BITS (TRACE_OUTREQQUEUED_BIT|TRACE_INREQQUEUED_BIT|TRACE_READ_BIT|\
TRACE_WRITE_BIT|TRACE_COMPLETE_BIT)
#else
# define TRACE_TRANSFER_BITS (0)
#endif
#ifdef CONFIG_SYSTEM_USBMSC_TRACECONTROLLER
# define TRACE_CONTROLLER_BITS (TRACE_EP_BIT|TRACE_DEV_BIT)
#else
# define TRACE_CONTROLLER_BITS (0)
#endif
#ifdef CONFIG_SYSTEM_USBMSC_TRACEINTERRUPTS
# define TRACE_INTERRUPT_BITS (TRACE_INTENTRY_BIT|TRACE_INTDECODE_BIT|TRACE_INTEXIT_BIT)
#else
# define TRACE_INTERRUPT_BITS (0)
#endif
#define TRACE_BITSET (TRACE_INIT_BITS|TRACE_ERROR_BITS|TRACE_CLASS_BITS|\
TRACE_TRANSFER_BITS|TRACE_CONTROLLER_BITS|TRACE_INTERRUPT_BITS)
/****************************************************************************
* Private Data
****************************************************************************/
/* All global variables used by this add-on are packed into a structure in
* order to avoid name collisions.
*/
struct usbmsc_state_s g_usbmsc;
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: show_memory_usage
****************************************************************************/
#ifdef CONFIG_SYSTEM_USBMSC_DEBUGMM
static void show_memory_usage(struct mallinfo *mmbefore,
struct mallinfo *mmafter)
{
int diff;
printf(" total used free largest\n");
printf("Before:%11d%11d%11d%11d\n",
mmbefore->arena, mmbefore->uordblks, mmbefore->fordblks,
mmbefore->mxordblk);
printf("After: %11d%11d%11d%11d\n",
mmafter->arena, mmafter->uordblks, mmafter->fordblks,
mmafter->mxordblk);
diff = mmbefore->uordblks - mmafter->uordblks;
if (diff < 0)
{
printf("Change:%11d allocated\n", -diff);
}
else if (diff > 0)
{
printf("Change:%11d freed\n", diff);
}
}
#else
# define show_memory_usage(mm1, mm2)
#endif
/****************************************************************************
* Name: check_test_memory_usage
****************************************************************************/
#ifdef CONFIG_SYSTEM_USBMSC_DEBUGMM
static void check_test_memory_usage(FAR const char *msg)
{
/* Get the current memory usage */
g_usbmsc.mmcurrent = mallinfo();
/* Show the change from the previous time */
printf("\%s:\n", msg);
show_memory_usage(&g_usbmsc.mmprevious, &g_usbmsc.mmcurrent);
/* Set up for the next test */
g_usbmsc.mmprevious = g_usbmsc.mmcurrent;
}
#else
# define check_test_memory_usage(msg)
#endif
/****************************************************************************
* Name: check_test_memory_usage
****************************************************************************/
#ifdef CONFIG_SYSTEM_USBMSC_DEBUGMM
static void final_memory_usage(FAR const char *msg)
{
/* Get the current memory usage */
g_usbmsc.mmcurrent = mallinfo();
/* Show the change from the previous time */
printf("\n%s:\n", msg);
show_memory_usage(&g_usbmsc.mmstart, &g_usbmsc.mmcurrent);
}
#else
# define final_memory_usage(msg)
#endif
/****************************************************************************
* Name: usbmsc_enumerate
****************************************************************************/
#ifdef CONFIG_SYSTEM_USBMSC_TRACE
static int usbmsc_enumerate(struct usbtrace_s *trace, void *arg)
{
switch (trace->event)
{
case TRACE_DEVINIT:
printf("USB controller initialization: %04x\n", trace->value);
break;
case TRACE_DEVUNINIT:
printf("USB controller un-initialization: %04x\n", trace->value);
break;
case TRACE_DEVREGISTER:
printf("usbdev_register(): %04x\n", trace->value);
break;
case TRACE_DEVUNREGISTER:
printf("usbdev_unregister(): %04x\n", trace->value);
break;
case TRACE_EPCONFIGURE:
printf("Endpoint configure(): %04x\n", trace->value);
break;
case TRACE_EPDISABLE:
printf("Endpoint disable(): %04x\n", trace->value);
break;
case TRACE_EPALLOCREQ:
printf("Endpoint allocreq(): %04x\n", trace->value);
break;
case TRACE_EPFREEREQ:
printf("Endpoint freereq(): %04x\n", trace->value);
break;
case TRACE_EPALLOCBUFFER:
printf("Endpoint allocbuffer(): %04x\n", trace->value);
break;
case TRACE_EPFREEBUFFER:
printf("Endpoint freebuffer(): %04x\n", trace->value);
break;
case TRACE_EPSUBMIT:
printf("Endpoint submit(): %04x\n", trace->value);
break;
case TRACE_EPCANCEL:
printf("Endpoint cancel(): %04x\n", trace->value);
break;
case TRACE_EPSTALL:
printf("Endpoint stall(true): %04x\n", trace->value);
break;
case TRACE_EPRESUME:
printf("Endpoint stall(false): %04x\n", trace->value);
break;
case TRACE_DEVALLOCEP:
printf("Device allocep(): %04x\n", trace->value);
break;
case TRACE_DEVFREEEP:
printf("Device freeep(): %04x\n", trace->value);
break;
case TRACE_DEVGETFRAME:
printf("Device getframe(): %04x\n", trace->value);
break;
case TRACE_DEVWAKEUP:
printf("Device wakeup(): %04x\n", trace->value);
break;
case TRACE_DEVSELFPOWERED:
printf("Device selfpowered(): %04x\n", trace->value);
break;
case TRACE_DEVPULLUP:
printf("Device pullup(): %04x\n", trace->value);
break;
case TRACE_CLASSBIND:
printf("Class bind(): %04x\n", trace->value);
break;
case TRACE_CLASSUNBIND:
printf("Class unbind(): %04x\n", trace->value);
break;
case TRACE_CLASSDISCONNECT:
printf("Class disconnect(): %04x\n", trace->value);
break;
case TRACE_CLASSSETUP:
printf("Class setup(): %04x\n", trace->value);
break;
case TRACE_CLASSSUSPEND:
printf("Class suspend(): %04x\n", trace->value);
break;
case TRACE_CLASSRESUME:
printf("Class resume(): %04x\n", trace->value);
break;
case TRACE_CLASSRDCOMPLETE:
printf("Class RD request complete: %04x\n", trace->value);
break;
case TRACE_CLASSWRCOMPLETE:
printf("Class WR request complete: %04x\n", trace->value);
break;
default:
switch (TRACE_ID(trace->event))
{
case TRACE_CLASSAPI_ID: /* Other class driver system API calls */
printf("Class API call %d: %04x\n",
TRACE_DATA(trace->event), trace->value);
break;
case TRACE_CLASSSTATE_ID: /* Track class driver state changes */
printf("Class state %d: %04x\n",
TRACE_DATA(trace->event), trace->value);
break;
case TRACE_INTENTRY_ID: /* Interrupt handler entry */
printf("Interrupt %d entry: %04x\n",
TRACE_DATA(trace->event), trace->value);
break;
case TRACE_INTDECODE_ID: /* Decoded interrupt trace->event */
printf("Interrupt decode %d: %04x\n",
TRACE_DATA(trace->event), trace->value);
break;
case TRACE_INTEXIT_ID: /* Interrupt handler exit */
printf("Interrupt %d exit: %04x\n",
TRACE_DATA(trace->event), trace->value);
break;
case TRACE_OUTREQQUEUED_ID: /* Request queued for OUT endpoint */
printf("EP%d OUT request queued: %04x\n",
TRACE_DATA(trace->event), trace->value);
break;
case TRACE_INREQQUEUED_ID: /* Request queued for IN endpoint */
printf("EP%d IN request queued: %04x\n",
TRACE_DATA(trace->event), trace->value);
break;
case TRACE_READ_ID: /* Read (OUT) action */
printf("EP%d OUT read: %04x\n",
TRACE_DATA(trace->event), trace->value);
break;
case TRACE_WRITE_ID: /* Write (IN) action */
printf("EP%d IN write: %04x\n",
TRACE_DATA(trace->event), trace->value);
break;
case TRACE_COMPLETE_ID: /* Request completed */
printf("EP%d request complete: %04x\n",
TRACE_DATA(trace->event), trace->value);
break;
case TRACE_DEVERROR_ID: /* USB controller driver error event */
printf("Controller error: %02x:%04x\n",
TRACE_DATA(trace->event), trace->value);
break;
case TRACE_CLSERROR_ID: /* USB class driver error event */
printf("Class error: %02x:%04x\n",
TRACE_DATA(trace->event), trace->value);
break;
default:
printf("Unrecognized event: %02x:%02x:%04x\n",
TRACE_ID(trace->event) >> 8,
TRACE_DATA(trace->event), trace->value);
break;
}
}
return OK;
}
#endif
/****************************************************************************
* Name: usbmsc_disconnect
*
* Description:
* Disconnect the USB MSC device
*
* Input Parameters:
* handle - Handle of the connect USB MSC device
*
* Returned Value:
* None
*
****************************************************************************/
static void usbmsc_disconnect(FAR void *handle)
{
struct boardioc_usbdev_ctrl_s ctrl;
ctrl.usbdev = BOARDIOC_USBDEV_MSC;
ctrl.action = BOARDIOC_USBDEV_DISCONNECT;
ctrl.instance = 0;
ctrl.handle = &handle;
boardctl(BOARDIOC_USBDEV_CONTROL, (uintptr_t)&ctrl);
}
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* msconn_main
*
* Description:
* This is the main program that configures the USB mass storage device
* and exports the LUN(s). If CONFIG_NSH_BUILTIN_APPS is defined
* in the NuttX configuration, then this program can be executed by
* entering the "msconn" command at the NSH console.
*
****************************************************************************/
int main(int argc, FAR char *argv[])
{
struct boardioc_usbdev_ctrl_s ctrl;
FAR void *handle = NULL;
int ret;
/* If this program is implemented as the NSH 'msconn' command, then we
* need to do a little error checking to assure that we are not being
* called re-entrantly.
*/
/* Check if there is a non-NULL USB mass storage device handle (meaning
* that the USB mass storage device is already configured).
*/
if (g_usbmsc.mshandle)
{
printf("mcsonn_main: ERROR: Already connected\n");
return EXIT_FAILURE;
}
#ifdef CONFIG_SYSTEM_USBMSC_DEBUGMM
g_usbmsc.mmstart = mallinfo();
g_usbmsc.mmprevious = g_usbmsc.mmstart;
#endif
/* Initialize USB trace output IDs */
#ifdef CONFIG_SYSTEM_USBMSC_TRACE
usbtrace_enable(TRACE_BITSET);
check_test_memory_usage("After usbtrace_enable()");
#endif
/* Register block drivers (architecture-specific) */
printf("mcsonn_main: Creating block drivers\n");
ctrl.usbdev = BOARDIOC_USBDEV_MSC;
ctrl.action = BOARDIOC_USBDEV_INITIALIZE;
ctrl.instance = 0;
ctrl.handle = NULL;
ret = boardctl(BOARDIOC_USBDEV_CONTROL, (uintptr_t)&ctrl);
if (ret < 0)
{
printf("mcsonn_main: boardctl(BOARDIOC_USBDEV_CONTROL) failed: %d\n",
-ret);
return EXIT_FAILURE;
}
check_test_memory_usage("After boardctl(BOARDIOC_USBDEV_CONTROL)");
/* Then exports the LUN(s) */
printf("mcsonn_main: Configuring with NLUNS=%d\n",
CONFIG_SYSTEM_USBMSC_NLUNS);
ret = usbmsc_configure(CONFIG_SYSTEM_USBMSC_NLUNS, &handle);
if (ret < 0)
{
printf("mcsonn_main: usbmsc_configure failed: %d\n", -ret);
if (handle)
{
usbmsc_disconnect(handle);
}
return EXIT_FAILURE;
}
printf("mcsonn_main: handle=%p\n", handle);
check_test_memory_usage("After usbmsc_configure()");
printf("mcsonn_main: Bind LUN=0 to %s\n",
CONFIG_SYSTEM_USBMSC_DEVPATH1);
#ifdef CONFIG_SYSTEM_USBMSC_WRITEPROTECT1
ret = usbmsc_bindlun(handle, CONFIG_SYSTEM_USBMSC_DEVPATH1, 0, 0, 0,
true);
#else
ret = usbmsc_bindlun(handle, CONFIG_SYSTEM_USBMSC_DEVPATH1, 0, 0, 0,
false);
#endif
if (ret < 0)
{
printf("mcsonn_main: usbmsc_bindlun failed for LUN 1 using %s: %d\n",
CONFIG_SYSTEM_USBMSC_DEVPATH1, -ret);
usbmsc_disconnect(handle);
return EXIT_FAILURE;
}
check_test_memory_usage("After usbmsc_bindlun()");
#if CONFIG_SYSTEM_USBMSC_NLUNS > 1
printf("mcsonn_main: Bind LUN=1 to %s\n",
CONFIG_SYSTEM_USBMSC_DEVPATH2);
#ifdef CONFIG_SYSTEM_USBMSC_WRITEPROTECT2
ret = usbmsc_bindlun(handle, CONFIG_SYSTEM_USBMSC_DEVPATH2, 1, 0, 0,
true);
#else
ret = usbmsc_bindlun(handle, CONFIG_SYSTEM_USBMSC_DEVPATH2, 1, 0, 0,
false);
#endif
if (ret < 0)
{
printf("mcsonn_main: usbmsc_bindlun failed for LUN 2 using %s: %d\n",
CONFIG_SYSTEM_USBMSC_DEVPATH2, -ret);
usbmsc_disconnect(handle);
return EXIT_FAILURE;
}
check_test_memory_usage("After usbmsc_bindlun() #2");
#if CONFIG_SYSTEM_USBMSC_NLUNS > 2
printf("mcsonn_main: Bind LUN=2 to %s\n",
CONFIG_SYSTEM_USBMSC_DEVPATH3);
#ifdef CONFIG_SYSTEM_USBMSC_WRITEPROTECT3
ret = usbmsc_bindlun(handle, CONFIG_SYSTEM_USBMSC_DEVPATH3, 2, 0, 0,
true);
#else
ret = usbmsc_bindlun(handle, CONFIG_SYSTEM_USBMSC_DEVPATH3, 2, 0, 0,
false);
#endif
if (ret < 0)
{
printf("mcsonn_main: usbmsc_bindlun failed for LUN 3 using %s: %d\n",
CONFIG_SYSTEM_USBMSC_DEVPATH3, -ret);
usbmsc_disconnect(handle);
return EXIT_FAILURE;
}
check_test_memory_usage("After usbmsc_bindlun() #3");
#endif
#endif
ret = usbmsc_exportluns(handle);
if (ret < 0)
{
printf("mcsonn_main: usbmsc_exportluns failed: %d\n", -ret);
usbmsc_disconnect(handle);
return EXIT_FAILURE;
}
check_test_memory_usage("After usbmsc_exportluns()");
/* Return the USB mass storage device handle so it can be used by the
* 'msconn' command.
*/
printf("mcsonn_main: Connected\n");
g_usbmsc.mshandle = handle;
check_test_memory_usage("After MS connection");
#ifdef CONFIG_SYSTEM_USBMSC_TRACE
/* This thread will hang around and monitor the USB storage activity */
for (; ; )
{
fflush(stdout);
sleep(5);
printf("\nmcsonn_main: USB TRACE DATA:\n");
ret = usbtrace_enumerate(usbmsc_enumerate, NULL);
if (ret < 0)
{
printf("mcsonn_main: usbtrace_enumerate failed: %d\n", -ret);
usbmsc_disconnect(handle);
return EXIT_FAILURE;
}
check_test_memory_usage("After usbtrace_enumerate()");
}
#endif
return EXIT_SUCCESS;
}
/****************************************************************************
* msdis_main
*
* Description:
* This is a program entry point that will disconnect the USB mass storage
* device. This program is only available if CONFIG_SYSTEM_USBMSC == y
* is defined in the NuttX configuration. In that case, this program can
* be executed by entering the "msdis" command at the NSH console.
*
****************************************************************************/
int msdis_main(int argc, char *argv[])
{
/* First check if the USB mass storage device is already connected */
if (!g_usbmsc.mshandle)
{
printf("msdis: ERROR: Not connected\n");
return EXIT_FAILURE;
}
check_test_memory_usage("Since MS connection");
/* Then disconnect the device and uninitialize the USB mass storage
* driver.
*/
usbmsc_disconnect(g_usbmsc.mshandle);
g_usbmsc.mshandle = NULL;
printf("msdis: Disconnected\n");
check_test_memory_usage("After usbmsc_disconnect()");
/* Dump debug memory usage */
final_memory_usage("Final memory usage");
return EXIT_SUCCESS;
}