1008ae7196
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3923 42af7a65-404d-4744-a932-0658087f49c3
119 lines
4.5 KiB
C
119 lines
4.5 KiB
C
/****************************************************************************
|
|
* apps/system/i2c/i2ctool.h
|
|
*
|
|
* Copyright (C) 2011 Gregory Nutt. All rights reserved.
|
|
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
* 3. Neither the name NuttX nor the names of its contributors may be
|
|
* used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
|
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
|
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
|
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
* POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __APPS_SYSTEM_I2C_I2CTOOLS_H
|
|
#define __APPS_SYSTEM_I2C_I2CTOOLS_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
#include <nuttx/compiler.h>
|
|
|
|
#include <sys/types.h>
|
|
#include <stdio.h>
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include <errno.h>
|
|
|
|
/****************************************************************************
|
|
* Definitions
|
|
****************************************************************************/
|
|
|
|
/* This is the maximum number of arguments that will be accepted for a command */
|
|
|
|
#define MAX_ARGUMENTS 6
|
|
|
|
/* Maximum size of one command line */
|
|
|
|
#define MAX_LINELEN 80
|
|
|
|
/* Output is via printf but can be changed using this macro */
|
|
|
|
#ifdef CONFIG_CPP_HAVE_VARARGS
|
|
# define i2c_output(v, fmt...) printf(v, ##fmt)
|
|
#else
|
|
# define i2c_output printf
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
typedef int (*cmd_t)(FAR void *handle, int argc, char **argv);
|
|
|
|
struct cmdmap_s
|
|
{
|
|
const char *cmd; /* Name of the command */
|
|
cmd_t handler; /* Function that handles the command */
|
|
uint8_t minargs; /* Minimum number of arguments (including command) */
|
|
uint8_t maxargs; /* Maximum number of arguments (including command) */
|
|
const char *usage; /* Usage instructions for 'help' command */
|
|
};
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
extern const char g_syntax[];
|
|
extern const char g_fmtargrequired[];
|
|
extern const char g_fmtarginvalid[];
|
|
extern const char g_fmtargrange[];
|
|
extern const char g_fmtcmdnotfound[];
|
|
extern const char g_fmtnosuch[];
|
|
extern const char g_fmttoomanyargs[];
|
|
extern const char g_fmtcmdfailed[];
|
|
extern const char g_fmtcmdoutofmemory[];
|
|
extern const char g_fmtinternalerror[];
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
/* Message handler */
|
|
|
|
ssize_t i2ctool_write(FAR void *handle, FAR const void *buffer, size_t nbytes);
|
|
int i2ctool_printf(FAR void *handle, const char *fmt, ...);
|
|
|
|
/* Command handlers */
|
|
|
|
extern int cmd_detect(FAR void *handle, int argc, char **argv);
|
|
extern int cmd_dump(FAR void *handle, int argc, char **argv);
|
|
extern int cmd_get(FAR void *handle, int argc, char **argv);
|
|
extern int cmd_set(FAR void *handle, int argc, char **argv);
|
|
|
|
#endif /* __APPS_SYSTEM_I2C_I2CTOOLS_H */
|