Home | History | Annotate | Download | only in Export_Inc
      1 /*
      2  * privateCmd.h
      3  *
      4  * Copyright(c) 1998 - 2009 Texas Instruments. All rights reserved.
      5  * All rights reserved.
      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  *  * Redistributions in binary form must reproduce the above copyright
     14  *    notice, this list of conditions and the following disclaimer in
     15  *    the documentation and/or other materials provided with the
     16  *    distribution.
     17  *  * Neither the name Texas Instruments nor the names of its
     18  *    contributors may be used to endorse or promote products derived
     19  *    from this software without specific prior written permission.
     20  *
     21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
     22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
     23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
     24  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
     25  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
     26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
     27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     32  */
     33 
     34 
     35 /****************************************************************************/
     36 /*																			*/
     37 /*    MODULE:   privateCmd.h													*/
     38 /*    PURPOSE:																*/
     39 /*																			*/
     40 /****************************************************************************/
     41 #ifndef _PVT_CMD_H_
     42 #define _PVT_CMD_H_
     43 
     44 
     45 /** \file  privateCmd.h
     46  * \brief Private Command	\n
     47  * This file contains all the data structures and definitions which are needed for Private Command
     48  * \n\n
     49  *
     50  * \n\n
     51  */
     52 
     53 #include "osTIType.h"
     54 
     55 /***********/
     56 /* defines */
     57 /***********/
     58 
     59 /** \def PRIVATE_CMD_SET_FLAG
     60  * \brief Bitmaks of bit which indicates that the Command is SET Command
     61  */
     62 #define PRIVATE_CMD_SET_FLAG	0x00000001
     63 /** \def PRIVATE_CMD_GET_FLAG
     64  * \brief Bitmaks of bit which indicates that the Command is GET Command
     65  */
     66 #define PRIVATE_CMD_GET_FLAG	0x00000002
     67 
     68 
     69 /*********/
     70 /* types */
     71 /*********/
     72 
     73 /** \struct ti_private_cmd_t
     74  * \brief TI Private Command
     75  *
     76  * \par Description
     77  * This Struct defines the Parameters needed for performing TI Private Command
     78  *
     79  * \sa
     80  */
     81 typedef struct
     82 {
     83 	TI_UINT32 	cmd;   			/**< Number of command to execute - configMgr parameter name			*/
     84 	TI_UINT32 	flags; 			/**< Command action type (PRIVATE_CMD_SET_FLAG | PRIVATE_CMD_GET_FLAG) 	*/
     85 	void* 		in_buffer; 		/**< Pointer to Input Buffer											*/
     86 	TI_UINT32	in_buffer_len; 	/**< Input buffer length 												*/
     87 	void* 		out_buffer;		/**< Pointer to Output buffer											*/
     88 	TI_UINT32	out_buffer_len;	/**< Output buffer length 												*/
     89 } ti_private_cmd_t;
     90 
     91 
     92 /*************/
     93 /* functions */
     94 /*************/
     95 
     96 #endif  /* _PVT_CMD_H_*/
     97 
     98