usb_moded.c 27.6 KB
Newer Older
1
/**
2 3 4
 * @file usb_moded.c
 *
 * Copyright (C) 2010 Nokia Corporation. All rights reserved.
5
 * Copyright (C) 2012-2019 Jolla. All rights reserved.
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
 *
 * @author: Philippe De Swert <philippe.de-swert@nokia.com>
 * @author: Philippe De Swert <phdeswer@lumi.maa>
 * @author: Philippe De Swert <philippedeswert@gmail.com>
 * @author: Philippe De Swert <philippe.deswert@jollamobile.com>
 * @author: Jonni Rainisto <jonni.rainisto@jollamobile.com>
 * @author: Pekka Lundstrom <pekka.lundstrom@jollamobile.com>
 * @author: Vesa Halttunen <vesa.halttunen@jollamobile.com>
 * @author: Simo Piiroinen <simo.piiroinen@jollamobile.com>
 * @author: Thomas Perl <thomas.perl@jolla.com>
 * @author: Matti Lehtimaki <matti.lehtimaki@gmail.com>
 * @author: Thomas Perl <m@thp.io>
 * @author: Martin Jones <martin.jones@jollamobile.com>
 * @author: Andrew den Exter <andrew.den.exter@jolla.com>
 * @author: Andrew den Exter <andrew.den.exter@jollamobile.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the Lesser GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the Lesser GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */

37
#include "usb_moded.h"
38 39 40 41 42 43

#include "usb_moded-android.h"
#include "usb_moded-appsync.h"
#include "usb_moded-config-private.h"
#include "usb_moded-configfs.h"
#include "usb_moded-control.h"
44
#include "usb_moded-dbus-private.h"
45
#include "usb_moded-devicelock.h"
46 47
#include "usb_moded-log.h"
#include "usb_moded-mac.h"
48 49
#include "usb_moded-modesetting.h"
#include "usb_moded-modules.h"
50
#include "usb_moded-network.h"
51
#include "usb_moded-sigpipe.h"
52
#include "usb_moded-systemd.h"
53 54
#include "usb_moded-trigger.h"
#include "usb_moded-udev.h"
55
#include "usb_moded-worker.h"
56

57
#ifdef MEEGOLOCK
58
# include "usb_moded-dsme.h"
59
#endif
60

61 62 63 64 65 66 67 68 69 70
#include <unistd.h>
#include <getopt.h>
#include <stdlib.h>
#include <errno.h>
#include <string.h>

#ifdef SYSTEMD
# include <systemd/sd-daemon.h>
#endif

71 72 73 74
/* ========================================================================= *
 * Constants
 * ========================================================================= */

75 76 77 78 79
/* Wakelogging is noisy, do not log it by default */
#ifndef  VERBOSE_WAKELOCKING
# define VERBOSE_WAKELOCKING 0
#endif

80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
/** Default allowed cable detection delay
 *
 * To comply with USB standards, the delay should be
 * less than 2 seconds to ensure timely enumeration.
 *
 * Any value <= zero means no delay.
 */
#define CABLE_CONNECTION_DELAY_DEFAULT 0

/** Maximum allowed cable detection delay
 *
 * Must be shorter than initial probing delay expected by
 * dsme (currently 5 seconds) to avoid reboot loops in
 * act dead mode.
 *
 * And shorter than USB_MODED_SUSPEND_DELAY_DEFAULT_MS to
 * allow the timer to trigger also in display off scenarios.
 */

#define CABLE_CONNECTION_DELAY_MAXIMUM 4000

101 102 103 104 105 106
/* ========================================================================= *
 * Prototypes
 * ========================================================================= */

/* -- usbmoded -- */

107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
GList           *usbmoded_get_modelist              (void);
void             usbmoded_load_modelist             (void);
void             usbmoded_free_modelist             (void);
bool             usbmoded_get_rescue_mode           (void);
void             usbmoded_set_rescue_mode           (bool rescue_mode);
bool             usbmoded_get_diag_mode             (void);
void             usbmoded_set_diag_mode             (bool diag_mode);
void             usbmoded_set_cable_connection_delay(int delay_ms);
int              usbmoded_get_cable_connection_delay(void);
static gboolean  usbmoded_allow_suspend_timer_cb    (gpointer aptr);
void             usbmoded_allow_suspend             (void);
void             usbmoded_delay_suspend             (void);
bool             usbmoded_init_done_p               (void);
void             usbmoded_set_init_done             (bool reached);
void             usbmoded_probe_init_done           (void);
bool             usbmoded_can_export                (void);
void             usbmoded_exit_mainloop             (int exitcode);
void             usbmoded_handle_signal             (int signum);
static bool      usbmoded_init                      (void);
static void      usbmoded_cleanup                   (void);
static void      usbmoded_usage                     (void);
static void      usbmoded_parse_options             (int argc, char *argv[]);
129

130
/* ========================================================================= *
131 132
 * Data
 * ========================================================================= */
133

134 135
static int        usbmoded_exitcode       = EXIT_FAILURE;
static GMainLoop *usbmoded_mainloop       = NULL;
136

137 138 139 140
static bool       usbmoded_hw_fallback    = false;
#ifdef SYSTEMD
static bool       usbmoded_systemd_notify = false;
#endif
141
static bool       usbmoded_auto_exit      = false;
142

143 144 145
/* ========================================================================= *
 * Functions
 * ========================================================================= */
146

147 148 149 150 151 152 153 154 155
/* ------------------------------------------------------------------------- *
 * MODELIST
 * ------------------------------------------------------------------------- */

static GList *usbmoded_modelist = 0;

GList *
usbmoded_get_modelist(void)
{
156 157
    LOG_REGISTER_CONTEXT;

158 159 160 161 162 163
    return usbmoded_modelist;
}

void
usbmoded_load_modelist(void)
{
164 165
    LOG_REGISTER_CONTEXT;

166 167 168 169 170 171 172 173 174
    if( !usbmoded_modelist ) {
        log_notice("load modelist");
        usbmoded_modelist = dynconfig_read_mode_list(usbmoded_get_diag_mode());
    }
}

void
usbmoded_free_modelist(void)
{
175 176
    LOG_REGISTER_CONTEXT;

177 178 179 180 181 182 183
    if( usbmoded_modelist ) {
        log_notice("free modelist");
        dynconfig_free_mode_list(usbmoded_modelist),
            usbmoded_modelist = 0;
    }
}

184 185 186 187 188 189 190 191 192 193 194 195 196 197
/* ------------------------------------------------------------------------- *
 * RESCUE_MODE
 * ------------------------------------------------------------------------- */

/** Rescue mode flag
 *
 * When enabled, usb-moded allows developer_mode etc when device is
 * booted up with cable connected without requiring device unlock.
 * Which can be useful if UI for some reason does not come up.
 */
static bool usbmoded_rescue_mode = false;

bool usbmoded_get_rescue_mode(void)
{
198 199
    LOG_REGISTER_CONTEXT;

200 201 202 203 204
    return usbmoded_rescue_mode;
}

void usbmoded_set_rescue_mode(bool rescue_mode)
{
205 206
    LOG_REGISTER_CONTEXT;

207 208 209 210 211 212
    if( usbmoded_rescue_mode != rescue_mode ) {
        log_info("rescue_mode: %d -> %d",  usbmoded_rescue_mode, rescue_mode);
        usbmoded_rescue_mode = rescue_mode;
    }
}

213 214 215 216 217 218 219 220 221 222 223 224 225
/* ------------------------------------------------------------------------- *
 * DIAG_MODE
 * ------------------------------------------------------------------------- */

/** Diagnostic mode active
 *
 * In diag mode usb-moded uses separate mode configuration which
 * should have exactly one mode defined / available.
 */
static bool usbmoded_diag_mode = false;

bool usbmoded_get_diag_mode(void)
{
226 227
    LOG_REGISTER_CONTEXT;

228 229 230 231 232
    return usbmoded_diag_mode;
}

void usbmoded_set_diag_mode(bool diag_mode)
{
233 234
    LOG_REGISTER_CONTEXT;

235 236 237 238 239 240
    if( usbmoded_diag_mode != diag_mode ) {
        log_info("diag_mode: %d -> %d",  usbmoded_diag_mode, diag_mode);
        usbmoded_diag_mode = diag_mode;
    }
}

241 242 243 244
/* ------------------------------------------------------------------------- *
 * CABLE_CONNECT_DELAY
 * ------------------------------------------------------------------------- */

245 246 247 248 249 250 251 252 253
/** PC connection delay
 *
 * Slow cable insert / similar physical issues can lead to a charger
 * getting initially recognized as a pc connection. This defines how
 * long we should wait and see if pc connection gets corrected to a
 * charger kind.
 */
static int usbmoded_cable_connection_delay = CABLE_CONNECTION_DELAY_DEFAULT;

254 255 256 257
/** Helper for setting allowed cable detection delay
 *
 * Used for implementing --max-cable-delay=<ms> option.
 */
258 259
void
usbmoded_set_cable_connection_delay(int delay_ms)
260
{
261 262
    LOG_REGISTER_CONTEXT;

263 264 265 266 267 268 269 270 271
    if( delay_ms > CABLE_CONNECTION_DELAY_MAXIMUM )
        delay_ms = CABLE_CONNECTION_DELAY_MAXIMUM;
    if( delay_ms < 0 )
        delay_ms = 0;

    if( usbmoded_cable_connection_delay != delay_ms ) {
        log_info("cable_connection_delay: %d -> %d",
                 usbmoded_cable_connection_delay,
                 delay_ms);
272
        usbmoded_cable_connection_delay = delay_ms;
273 274 275
    }
}

276 277 278 279 280
/** Helper for getting allowed cable detection delay
 */
int
usbmoded_get_cable_connection_delay(void)
{
281 282
    LOG_REGISTER_CONTEXT;

283 284 285
    return usbmoded_cable_connection_delay;
}

286 287 288 289 290 291 292 293 294 295
/* ------------------------------------------------------------------------- *
 * SUSPEND_BLOCKING
 * ------------------------------------------------------------------------- */

/** Flag for: USB_MODED_WAKELOCK_STATE_CHANGE has been acquired */
static bool usbmoded_blocking_suspend = false;

/** Timer for releasing USB_MODED_WAKELOCK_STATE_CHANGE */
static guint usbmoded_allow_suspend_timer_id = 0;

296
/** Timer callback for releasing wakelock acquired via usbmoded_delay_suspend()
297
 *
298
 * @param aptr callback argument (not used)
299
 */
300
static gboolean usbmoded_allow_suspend_timer_cb(gpointer aptr)
301
{
302 303
    LOG_REGISTER_CONTEXT;

304 305
    (void)aptr;

306
    usbmoded_allow_suspend_timer_id = 0;
307 308 309 310

    usbmoded_allow_suspend();

    return FALSE;
311 312
}

313
/** Release wakelock acquired via usbmoded_delay_suspend()
314
 *
315 316
 * Meant to be called on usb-moded exit so that wakelocks
 * are not left behind.
317
 */
318
void usbmoded_allow_suspend(void)
319
{
320 321
    LOG_REGISTER_CONTEXT;

322 323 324
    if( usbmoded_allow_suspend_timer_id ) {
        g_source_remove(usbmoded_allow_suspend_timer_id),
            usbmoded_allow_suspend_timer_id = 0;
325
    }
326

327 328 329
    if( usbmoded_blocking_suspend ) {
        usbmoded_blocking_suspend = false;
        common_release_wakelock(USB_MODED_WAKELOCK_STATE_CHANGE);
330
    }
331 332 333 334 335 336 337 338 339 340 341 342
}

/** Block suspend briefly
 *
 * Meant to be called in situations usb activity might have woken
 * up the device (cable connect while display is off), or could
 * allow device to suspend (cable disconnect while display is off).
 *
 * Allows usb moded some time to finish asynchronous activity and
 * other processes to receive and process state changes broadcast
 * by usb-moded.
 */
343
void usbmoded_delay_suspend(void)
344
{
345 346
    LOG_REGISTER_CONTEXT;

347 348
    /* Use of automatically terminating wakelocks also means we need
     * to renew the wakelock when extending the suspend delay. */
349
    common_acquire_wakelock(USB_MODED_WAKELOCK_STATE_CHANGE);
350

351
    usbmoded_blocking_suspend = true;
352

353 354
    if( usbmoded_allow_suspend_timer_id )
        g_source_remove(usbmoded_allow_suspend_timer_id);
355

356
    usbmoded_allow_suspend_timer_id =
357 358
        g_timeout_add(USB_MODED_SUSPEND_DELAY_DEFAULT_MS,
                      usbmoded_allow_suspend_timer_cb, 0);
359 360
}

361 362 363 364
/* ------------------------------------------------------------------------- *
 * CAN_EXPORT
 * ------------------------------------------------------------------------- */

365 366 367 368 369 370
/** Check if exposing device data is currently allowed
 *
 * @return true exposing data is ok, or false otherwise
 */
bool usbmoded_can_export(void)
{
371 372
    LOG_REGISTER_CONTEXT;

373 374 375 376 377 378 379 380 381
  bool can_export = true;

#ifdef MEEGOLOCK
    /* Modes that potentially expose data are allowed only when
     * device is running in user mode and device is unlocked */
    can_export = (dsme_in_user_state() &&
                  devicelock_have_export_permission());

    /* Having bootup rescue mode active is an exception */
382
    if( usbmoded_get_rescue_mode() )
383 384 385 386 387 388
        can_export = true;
#endif

    return can_export;
}

389 390 391 392 393 394 395 396 397 398
/* ------------------------------------------------------------------------- *
 * INIT_DONE
 * ------------------------------------------------------------------------- */

/** Path to init-done flag file */
static const char usbmoded_init_done_flagfile[] = "/run/systemd/boot-status/init-done";

/** cached init-done-reached state */
static bool usbmoded_init_done_reached = false;

399 400 401 402
/** Check if system has already been successfully booted up
 *
 * @return true if init-done has been reached, or false otherwise
 */
403
bool usbmoded_init_done_p(void)
404
{
405 406
    LOG_REGISTER_CONTEXT;

407
    return usbmoded_init_done_reached;
408 409 410
}

/** Update cached init-done-reached state */
411
void usbmoded_set_init_done(bool reached)
412
{
413 414
    LOG_REGISTER_CONTEXT;

415 416
    if( usbmoded_init_done_reached != reached ) {
        usbmoded_init_done_reached = reached;
417
        log_warning("init_done -> %s",
418
                    usbmoded_init_done_reached ? "reached" : "not reached");
419
    }
420 421 422
}

/** Check whether init-done flag file exists */
423
void usbmoded_probe_init_done(void)
424
{
425 426
    LOG_REGISTER_CONTEXT;

427
    usbmoded_set_init_done(access(usbmoded_init_done_flagfile, F_OK) == 0);
428 429
}

430 431 432 433
/* ------------------------------------------------------------------------- *
 * MAINLOOP
 * ------------------------------------------------------------------------- */

434 435
/** Request orderly exit from mainloop
 */
436 437
void usbmoded_exit_mainloop(int exitcode)
{
438 439
    LOG_REGISTER_CONTEXT;

440 441
    /* In case multiple exit request get done, retain the
     * highest exit code used. */
442 443
    if( usbmoded_exitcode < exitcode )
        usbmoded_exitcode = exitcode;
444 445

    /* If there is no mainloop to exit, terminate immediately */
446
    if( !usbmoded_mainloop )
447 448
    {
        log_warning("exit requested outside mainloop; exit(%d) now",
449 450
                    usbmoded_exitcode);
        exit(usbmoded_exitcode);
451 452 453
    }

    log_debug("stopping usb-moded mainloop");
454
    g_main_loop_quit(usbmoded_mainloop);
455 456
}

457
void usbmoded_handle_signal(int signum)
458
{
459 460
    LOG_REGISTER_CONTEXT;

461 462 463 464 465 466 467 468 469 470
    log_debug("handle signal: %s\n", strsignal(signum));

    if( signum == SIGTERM )
    {
        /* Assume: Stopped by init process */
        usbmoded_exit_mainloop(EXIT_SUCCESS);
    }
    else if( signum == SIGHUP )
    {
        /* free and read in modelist again */
471 472
        usbmoded_free_modelist();
        usbmoded_load_modelist();
473

474 475
        common_send_supported_modes_signal();
        common_send_available_modes_signal();
476 477

        // FIXME invalidate current mode
478 479 480 481 482 483 484
    }
    else
    {
        usbmoded_exit_mainloop(EXIT_FAILURE);
    }
}

485 486
/* Prepare usb-moded for running the mainloop */
static bool usbmoded_init(void)
487
{
488 489
    LOG_REGISTER_CONTEXT;

490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
    bool ack = false;

    /* Check if we are in mid-bootup */
    usbmoded_probe_init_done();

    if( !worker_init() ) {
        log_crit("worker thread init failed");
      goto EXIT;
    }

    if( !sigpipe_init() ) {
        log_crit("signal handler init failed");
        goto EXIT;
    }

505 506
    if( usbmoded_get_rescue_mode() && usbmoded_init_done_p() ) {
        usbmoded_set_rescue_mode(false);
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
        log_warning("init done passed; rescue mode ignored");
    }

    /* Connect to SystemBus */
    if( !umdbus_init_connection() ) {
        log_crit("dbus systembus connection failed");
        goto EXIT;
    }

    /* Start DBus trackers that do async initialization
     * so that initial method calls are on the way while
     * we do initialization actions that might block. */

    /* DSME listener maintains in-user-mode state and is relevant
     * only when MEEGOLOCK configure option has been chosen. */
#ifdef MEEGOLOCK
    if( !dsme_listener_start() ) {
        log_crit("dsme tracking could not be started");
        goto EXIT;
    }
#endif

    /* Devicelock listener maintains devicelock state and is relevant
     * only when MEEGOLOCK configure option has been chosen. */
#ifdef MEEGOLOCK
    if( !devicelock_start_listener() ) {
        log_crit("devicelock tracking could not be started");
        goto EXIT;
    }
#endif

    /* Set daemon config/state data to sane state */
    modesetting_init();

541
    /* check config, merge or create if outdated */
542
    if( !config_init() ) {
543 544
        log_crit("Cannot create or find a valid configuration");
        goto EXIT;
545 546 547
    }

#ifdef APP_SYNC
548
    appsync_read_list(usbmoded_get_diag_mode());
549 550 551
#endif

    /* always read dyn modes even if appsync is not used */
552
    usbmoded_load_modelist();
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568

    if(config_check_trigger())
        trigger_init();

    /* Set-up mac address before kmod */
    if(access("/etc/modprobe.d/g_ether.conf", F_OK) != 0)
    {
        mac_generate_random_mac();
    }

    /* During bootup the sysfs control structures might
     * not be already in there when usb-moded starts up.
     * Retry few times unless init done is / gets reached
     * while waiting.
     */
    for( int i = 10; ; ) {
569
        if( configfs_init() )
570 571
            break;

572
        if( android_init() )
573 574
            break;

575
        /* Must probe / poll since we're not yet running mainloop */
576 577 578 579 580 581 582 583
        usbmoded_probe_init_done();

        if( usbmoded_init_done_p() || --i <= 0 ) {
            if( !modules_init() )
                log_crit("No supported usb control mechanisms found");
            break;
        }

584
        common_msleep(1000);
585 586
    }

587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
    /* Allow making systemd control ipc */
    if( !systemd_control_start() ) {
        log_crit("systemd control could not be started");
        goto EXIT;
    }

    /* If usb-moded happens to crash, it could leave appsync processes
     * running. To make sure things are in the order expected by usb-moded
     * force stopping of appsync processes during usb-moded startup.
     *
     * The exception is: When usb-moded starts as a part of bootup. Then
     * we can be relatively sure that usb-moded has not been running yet
     * and therefore no appsync processes have been started and we can
     * skip the blocking ipc required to stop the appsync systemd units. */
#ifdef APP_SYNC
    if( usbmoded_init_done_p() ) {
        log_warning("usb-moded started after init-done; "
                    "forcing appsync stop");
        appsync_stop(true);
    }
#endif

    /* Claim D-Bus service name before proceeding with things that
     * could result in dbus signal broadcasts from usb-moded interface.
     */
    if( !umdbus_init_service() ) {
        log_crit("usb-moded dbus service init failed");
        goto EXIT;
    }

    /* Initialize udev listener. Can cause mode changes.
     *
     * Failing here is allowed if '--fallback' commandline option is used.
     */
    if( !umudev_init() && !usbmoded_hw_fallback ) {
        log_crit("hwal init failed");
        goto EXIT;
    }

    /* Broadcast supported / hidden modes */
    // TODO: should this happen before umudev_init()?
    common_send_supported_modes_signal();
    common_send_available_modes_signal();
    common_send_hidden_modes_signal();
    common_send_whitelisted_modes_signal();

    /* Act on '--fallback' commandline option */
    if( usbmoded_hw_fallback ) {
        log_warning("Forcing USB state to connected always. ASK mode non functional!");
        /* Since there will be no disconnect signals coming from hw the state should not change */
        control_set_cable_state(CABLE_STATE_PC_CONNECTED);
    }

    ack = true;

EXIT:
    return ack;
644 645 646 647 648 649
}

/** Release resources allocated by usbmoded_init()
 */
static void usbmoded_cleanup(void)
{
650 651
    LOG_REGISTER_CONTEXT;

652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
    /* Stop the worker thread first to avoid confusion about shared
     * resources we are just about to release. */
    worker_quit();

    /* Detach from SystemBus. Components that hold reference to the
     * shared bus connection can still perform cleanup tasks, but new
     * references can't be obtained anymore and usb-moded method call
     * processing no longer occurs. */
    umdbus_cleanup();

    /* Stop appsync processes that have been started by usb-moded */
#ifdef APP_SYNC
    appsync_stop(false);
#endif

    /* Deny making systemd control ipc */
    systemd_control_stop();

    /* Stop tracking devicelock status */
#ifdef MEEGOLOCK
    devicelock_stop_listener();
#endif

    /* Stop tracking device state */
#ifdef MEEGOLOCK
    dsme_listener_stop();
#endif

    /* Stop udev listener */
    umudev_quit();

683
    /* Do backend specific cleanup */
684
    modules_quit();
685 686
    android_quit();
    configfs_quit();
687 688 689 690

    /* Undo trigger_init() */
    trigger_stop();

691 692
    /* Undo usbmoded_load_modelist() */
    usbmoded_free_modelist();
693 694 695 696 697 698 699

#ifdef APP_SYNC
    /* Undo appsync_read_list() */
    appsync_free_appsync_list();
#endif

    /* Release dynamic memory */
700
    worker_clear_kernel_module();
701 702 703 704
    worker_clear_hardware_mode();
    control_clear_cable_state();
    control_clear_internal_mode();
    control_clear_external_mode();
705
    control_clear_target_mode();
706 707 708 709 710 711 712 713 714 715 716

    modesetting_quit();

    /* Detach from SessionBus connection used for APP_SYNC_DBUS.
     *
     * Can be handled separately from SystemBus side wind down. */
#ifdef APP_SYNC
# ifdef APP_SYNC_DBUS
    dbusappsync_cleanup();
# endif
#endif
717 718 719 720 721 722
}

/* ========================================================================= *
 * MAIN ENTRY
 * ========================================================================= */

723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
static const char usbmoded_usage_info[] =
"Usage: usb_moded [OPTION]...\n"
"USB mode daemon\n"
"\n"
"  -a,  --android_usb_broken\n"
"      keep gadget active on broken android kernels\n"
"  -i,  --android_usb_broken_udev_events\n"
"      ignore incorrect disconnect events after mode setting\n"
"  -f,  --fallback       \n"
"      assume always connected\n"
"  -s,  --force-syslog \n"
"      log to syslog\n"
"  -T,  --force-stderr \n"
"      log to stderr\n"
"  -l,  --log-line-info\n"
"      log to stderr and show origin of logging\n"
"  -D,  --debug  \n"
"      turn on debug printing\n"
"  -d,  --diag   \n"
"      turn on diag mode\n"
"  -h,  --help         \n"
"      display this help and exit\n"
"  -r,  --rescue         \n"
"      rescue mode\n"
#ifdef SYSTEMD
"  -n,  --systemd      \n"
"      notify systemd when started up\n"
#endif
"  -v,  --version      \n"
"      output version information and exit\n"
"  -m,  --max-cable-delay=<ms>\n"
"      maximum delay before accepting cable connection\n"
"  -b,  --android-bootup-function=<function>\n"
"      Setup given function during bootup. Might be required\n"
"      on some devices to make enumeration work on the 1st\n"
"      cable connect.\n"
"\n";

static const struct option const usbmoded_long_options[] =
{
    { "android_usb_broken",             no_argument,       0, 'a' },
    { "android_usb_broken_udev_events", no_argument,       0, 'i' },
    { "fallback",                       no_argument,       0, 'd' },
    { "force-syslog",                   no_argument,       0, 's' },
    { "force-stderr",                   no_argument,       0, 'T' },
    { "log-line-info",                  no_argument,       0, 'l' },
    { "debug",                          no_argument,       0, 'D' },
    { "diag",                           no_argument,       0, 'd' },
    { "help",                           no_argument,       0, 'h' },
    { "rescue",                         no_argument,       0, 'r' },
    { "systemd",                        no_argument,       0, 'n' },
    { "version",                        no_argument,       0, 'v' },
    { "max-cable-delay",                required_argument, 0, 'm' },
    { "android-bootup-function",        required_argument, 0, 'b' },
777
    { "auto-exit",                      no_argument,       0, 'Q' },
778 779 780
    { 0, 0, 0, 0 }
};

781
static const char usbmoded_short_options[] = "aifsTlDdhrnvm:b:Q";
782

783 784 785
/* Display usbmoded_usage information */
static void usbmoded_usage(void)
{
786 787
    LOG_REGISTER_CONTEXT;

788
    fprintf(stdout, "%s", usbmoded_usage_info);
789
}
790

791
static void usbmoded_parse_options(int argc, char* argv[])
792
{
793 794
    LOG_REGISTER_CONTEXT;

795
    /* Parse the command-line options */
796 797 798 799 800 801 802 803
    for( ;; ) {
        int opt = getopt_long(argc, argv,
                              usbmoded_short_options,
                              usbmoded_long_options,
                              0);
        if( opt == -1 )
            break;

804 805 806
        switch (opt)
        {
        case 'a':
807
            log_warning("Deprecated option: --android_usb_broken");
808 809
            break;
        case 'i':
810
            log_warning("Deprecated option: --android_usb_broken_udev_events");
811 812
            break;
        case 'f':
813
            usbmoded_hw_fallback = true;
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
            break;
        case 's':
            log_set_type(LOG_TO_SYSLOG);
            break;

        case 'T':
            log_set_type(LOG_TO_STDERR);
            break;

        case 'D':
            log_set_level(LOG_DEBUG);
            break;

        case 'l':
            log_set_type(LOG_TO_STDERR);
            log_set_lineinfo(true);
            break;

        case 'd':
833
            usbmoded_set_diag_mode(true);
834 835 836 837
            break;

        case 'h':
            usbmoded_usage();
838
            exit(EXIT_SUCCESS);
839 840

        case 'r':
841
            usbmoded_set_rescue_mode(true);
842
            break;
843
#ifdef SYSTEMD
844
        case 'n':
845
            usbmoded_systemd_notify = true;
846 847 848 849
            break;
#endif
        case 'v':
            printf("USB mode daemon version: %s\n", VERSION);
850
            exit(EXIT_SUCCESS);
851 852 853 854 855 856

        case 'm':
            usbmoded_set_cable_connection_delay(strtol(optarg, 0, 0));
            break;

        case 'b':
857
            log_warning("Deprecated option: --android-bootup-function");
858 859
            break;

860 861 862 863
        case 'Q':
          usbmoded_auto_exit = true;
          break;

864 865
        default:
            usbmoded_usage();
866
            exit(EXIT_FAILURE);
867 868
        }
    }
869
}
870

871 872
int main(int argc, char* argv[])
{
873 874
    LOG_REGISTER_CONTEXT;

875 876 877
    /* Library init calls that should be made before
     * using library functionality.
     */
878
#if !GLIB_CHECK_VERSION(2, 36, 0)
879
    g_type_init();
880
#endif
881
#if !GLIB_CHECK_VERSION(2, 31, 0)
882
    g_thread_init(NULL);
883
#endif
884 885
    dbus_threads_init_default();

886 887 888
    /* - - - - - - - - - - - - - - - - - - - *
     * OPTIONS
     * - - - - - - - - - - - - - - - - - - - */
889

890 891 892
    /* Set logging defaults */
    log_init();
    log_set_name(basename(*argv));
893

894 895
    /* Parse command line options */
    usbmoded_parse_options(argc, argv);
896

897 898
    fprintf(stderr, "usb_moded %s starting\n", VERSION);
    fflush(stderr);
899

900 901
    /* Silence common_system() calls */
    if( log_get_type() != LOG_TO_STDERR && log_get_level() != LOG_DEBUG )
902
    {
903 904 905 906 907 908
        if( !freopen("/dev/null", "a", stdout) ) {
            log_err("can't redirect stdout: %m");
        }
        if( !freopen("/dev/null", "a", stderr) ) {
            log_err("can't redirect stderr: %m");
        }
909
    }
910

911 912 913
    /* - - - - - - - - - - - - - - - - - - - *
     * INITIALIZE
     * - - - - - - - - - - - - - - - - - - - */
914

915
    if( !usbmoded_init() )
916 917 918 919 920 921 922
        goto EXIT;

    /* - - - - - - - - - - - - - - - - - - - *
     * EXECUTE
     * - - - - - - - - - - - - - - - - - - - */

    /* Tell systemd that we have started up */
923
#ifdef SYSTEMD
924 925
    if( usbmoded_systemd_notify ) {
        log_debug("notifying systemd");
926 927
        sd_notify(0, "READY=1");
    }
928 929
#endif

930
    /* init succesful, run main loop */
931
    usbmoded_exitcode = EXIT_SUCCESS;
932 933 934 935

    if( usbmoded_auto_exit )
        goto EXIT;

936
    usbmoded_mainloop = g_main_loop_new(NULL, FALSE);
937

938
    log_debug("enter usb-moded mainloop");
939
    g_main_loop_run(usbmoded_mainloop);
940
    log_debug("leave usb-moded mainloop");
941

942 943
    g_main_loop_unref(usbmoded_mainloop),
        usbmoded_mainloop = 0;
944

945 946 947
    /* - - - - - - - - - - - - - - - - - - - *
     * CLEANUP
     * - - - - - - - - - - - - - - - - - - - */
948
EXIT:
949
    usbmoded_cleanup();
950

951 952 953
    /* Memory leak debugging - instruct libdbus to flush resources. */
#if 0
    dbus_shutdown();
954 955
#endif

956 957 958 959
    /* - - - - - - - - - - - - - - - - - - - *
     * EXIT
     * - - - - - - - - - - - - - - - - - - - */

960 961 962
    /* Must be done just before exit to make sure no more wakelocks
     * are taken and left behind on exit path */
    usbmoded_allow_suspend();
963

964
    log_debug("usb-moded return from main, with exit code %d",
965 966
              usbmoded_exitcode);
    return usbmoded_exitcode;
967
}