include/help.h

   1 /*
   2  * Help Library Header File for K3CONF
   3  *
   4  * Copyright (C) 2019 Texas Instruments Incorporated - http://www.ti.com/
   5  *      Lokesh Vutla <lokeshvutla@ti.com>
   6  *
   7  *  Redistribution and use in source and binary forms, with or without
   8  *  modification, are permitted provided that the following conditions
   9  *  are met:
  10  *
  11  *    Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *
  14  *    Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the
  17  *    distribution.
  18  *
  19  *    Neither the name of Texas Instruments Incorporated nor the names of
  20  *    its contributors may be used to endorse or promote products derived
  21  *    from this software without specific prior written permission.
  22  *
  23  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  24  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  25  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  26  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  27  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  28  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  29  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  30  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  31  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  32  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  33  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  */
  35
  36 #ifndef __K3CONF_HELP
  37 #define __K3CONF_HELP
  38
  39 typedef enum {
  40         HELP_USAGE,
  41         HELP_SHOW,
  42         HELP_SHOW_HOST,
  43         HELP_SHOW_SEC_PROXY,
  44         HELP_SHOW_DEVICE,
  45         HELP_SHOW_CLOCK,
  46         HELP_SHOW_PROCESSOR,
  47         HELP_DUMP,
  48         HELP_DUMP_DEVICE,
  49         HELP_DUMP_CLOCK,
  50         HELP_DUMP_PROCESSOR,
  51         HELP_ENABLE,
  52         HELP_ENABLE_DEVICE,
  53         HELP_ENABLE_CLOCK,
  54         HELP_DISABLE,
  55         HELP_DISABLE_DEVICE,
  56         HELP_DISABLE_CLOCK,
  57         HELP_SET,
  58         HELP_SET_CLOCK,
  59         HELP_READ,
  60         HELP_WRITE,
  61         HELP_ALL,
  62         HELP_CATEGORY_MAX,
  63 } help_category;
  64
  65 void help(help_category cat);
  66 #endif