hostif_high.h

本程序为ST公司开发的源代码

/**************************************************
 *
 * hostif_high.h
 *
 * CVS ID:   $Id: hostif_high.h,v 1.82 2007/11/21 09:30:48 belardi Exp $
 * Author:   Raffaele Belardi [RB] - STM
 * Date:     $Date: 2007/11/21 09:30:48 $
 * Revision: $Revision: 1.82 $
 * 
 * Description:
 * 
 ***************************************************
 * 
 * COPYRIGHT (C) ST Microelectronics  2005
 *            All Rights Reserved
 *
 ***************************************************
 *
 * STM CVS Log:
 *
 * $Log: hostif_high.h,v $
 * Revision 1.82  2007/11/21 09:30:48  belardi
 * version bump for 3.0
 *
 * Revision 1.81  2007/11/15 16:05:40  belardi
 * Version bump
 *
 * Revision 1.80  2007/11/15 13:21:29  belardi
 * New request/message ReqCurrentPlaylistAbsContent
 *
 * Revision 1.79  2007/11/06 16:49:35  belardi
 * Product id change for PRE33
 *
 * Revision 1.78  2007/10/26 13:45:53  belardi
 * ProductId embeds pre-release number in SoftwareReleaseDay
 *
 * Revision 1.77  2007/10/02 09:14:11  belardi
 * Version bump
 *
 * Revision 1.76  2007/08/21 08:11:18  belardi
 * Added error #define
 *
 * Revision 1.75  2007/08/09 09:01:15  marcucci
 * REQ_MISSING_ITEMS and REQ_MECHANICAL_MEASUREMETS
 * commands added
 *
 * Revision 1.74  2007/08/07 15:19:49  belardi
 * Changed date in product string
 *
 * Revision 1.73  2007/08/02 14:42:26  sedmik
 * new define for entry name type
 *
 * Revision 1.72  2007/08/02 13:36:12  sedmik
 * commands/messages defines(ReqDirContent, ReqUSBdeviceInfo),  struct for dir content params, func prototypes
 *
 * Revision 1.71  2007/07/09 16:47:31  sedmik
 * added define for MsgCAFileInfo
 *
 * Revision 1.70  2007/07/04 10:05:13  belardi
 * First implementation of new interface to retrieve USB serial number
 * Not completely debugged due to possible problem in USB driver
 *
 * Revision 1.69  2007/07/03 14:55:28  belardi
 * New type value in ReqEntryName to get filename with index relative to playlist
 *
 * Revision 1.68  2007/06/29 13:17:32  belardi
 * Added support for Track Number in ID3 v1.1 and v2.x
 *
 * Revision 1.67  2007/06/29 09:50:33  marcucci
 * Added the frame for REQ_USB_HIGH_Z  commnad to put in High Impedance the D+/D-Lines
 *
 * Revision 1.66  2007/06/28 20:53:52  longauer
 * 1.Usb restructuralization in order to supports more LUNs and interface preparation
 *  for iAP; 2.PHY emulation moved; 3.compilation works with IPOD_PASSTHROUGH==0; 4.
 *  usb patching init moved from main.c
 *
 * Revision 1.65  2007/03/28 15:12:36  belardi
 * Changed release date in productID string
 *
 * Revision 1.64  2007/03/19 17:14:16  belardi
 * New version number
 *
 * Revision 1.63  2007/03/06 15:59:54  belardi
 * Modified MsgInsertMode values for back compatibility
 *
 * Revision 1.62  2007/03/05 15:11:51  belardi
 * Addition to CIS:
 * - new parameter in MsgPlayerMode indicating current source
 * - new values for PAR11 of MsgTimeInfo to indicate the type of file (CDDA, MP3, WMA, AAC)
 * - new command/message ReqLongEntryName to transmit the filename in multi-packet format
 *
 * Revision 1.61  2007/03/02 14:28:42  sedmik
 * MsgInsertMode changes in params
 *
 * Revision 1.60  2007/02/23 14:37:48  sedmik
 * MsgInsertMode reverted to older definitions
 *
 * Revision 1.59  2007/02/23 11:39:28  sedmik
 * define added (CMD_PARAM_END_OF_FILE_POSITION), removed insert_mode,  changed func prototype of report_msg_insert_mode
 *
 * Revision 1.58  2007/02/21 20:18:14  longauer
 * usb states and error reorganization;  usb state is propagated to player task = usb
 *  state messaging
 *
 * Revision 1.57  2007/02/15 16:08:02  sedmik
 * removed func prototypes, moved to hostif_high.c
 *
 * Revision 1.56  2007/02/13 11:03:34  sedmik
 * structures for up/downstream added new params
 *
 * Revision 1.55  2007/02/09 12:06:35  belardi
 * First integration of iPod pass-through:
 * - downstream passthrough ok, upstream not optimizing use of the hostif buffer
 * - broken host update protocol
 *
 * Revision 1.54  2006/12/19 17:05:30  belardi
 * Changed version release date to final
 *
 * Revision 1.53  2006/12/13 09:31:20  belardi
 * Version bump
 *
 * Revision 1.52  2006/12/04 14:44:49  dellorto
 * added emergency eject command
 *
 * Revision 1.51  2006/11/27 19:50:09  belardi
 * Host Update protocol addition
 * - new functions
 *
 * Revision 1.50  2006/11/24 11:37:12  zhong
 * Karbin for Temperature sensor detect
 *
 * Revision 1.49  2006/11/22 17:22:49  sedmik
 * aligned MsgInsertMode PAR1 bits with CIS 0.09
 *
 * Revision 1.48  2006/11/21 13:59:11  dellorto
 * improved hostif reporting of servo parameters in case of restart
 *
 * Revision 1.47  2006/11/20 13:27:18  sedmik
 * changed substates of MSG_DISC_TYPE,
 * added REQ_DISC_INFO, playlist type in t_msg_directory_entries_tag
 *
 * Revision 1.46  2006/11/17 16:38:57  dellorto
 * added PVD address in read TOC message
 * added auto text messages
 * added configurable text item length
 *
 * Revision 1.45  2006/11/16 17:00:12  belardi
 * removed $ Name $ keyword, does not work as expected
 *
 * Revision 1.44  2006/11/16 16:58:21  belardi
 * Testing the $ Name $ CVS keyword
 *
 * Revision 1.43  2006/11/16 16:55:42  belardi
 * Testing the $ Name $ CVS keyword
 *
 * Revision 1.42  2006/11/16 15:57:00  belardi
 * Added the product string in ASCII for quick version check on .hex releases
 *
 * Revision 1.41  2006/11/15 14:18:45  dellorto
 * added messages for read TOC
 *
 * Revision 1.40  2006/11/13 18:01:06  belardi
 * Cahnged definition of PRODUCT_ID to comply with CIS0.09
 *
 * Revision 1.39  2006/11/10 16:29:27  dellorto
 * added support for servo parameters sending
 *
 * Revision 1.38  2006/11/09 19:11:52  belardi
 * Removed unused code and variables, leftover of TransportLayer implementation, no more needed since long time
 *
 * Revision 1.37  2006/11/09 16:23:00  belardi
 * Removed unused function
 *
 * Revision 1.36  2006/11/07 18:58:53  sedmik
 * added playlist support defines
 *
 * Revision 1.35  2006/10/27 15:11:06  sedmik
 * func prototype report_msg_entry_name change
 *
 * Revision 1.34  2006/10/20 15:41:10  belardi
 * Support for long multi-packet transmission (or scheduled tx)
 *
 * Revision 1.33  2006/10/20 12:35:00  belardi
 * Version bump (temporary date)
 *
 * Revision 1.32  2006/10/06 13:52:01  belardi
 * Changed version number
 *
 * Revision 1.31  2006/09/18 09:34:42  belardi
 * Corrected CVS keyword usage
 *
 * Revision 1.30  2006/09/18 09:32:28  belardi
 * Version change
 *
 * Revision 1.29  2006/09/18 09:24:13  belardi
 * Added CVS keyword into file header
 *
 *
 ***************************************************/
#ifndef _HOSTIF_HIGH_H_
#define _HOSTIF_HIGH_H_

#include "configuration.h"
#include "player.h"
#include "apdevsys.h"
#include "hostif_low.h"

/* Product ID definition. */
/* Format is one byte per entry, total 9 bytes */
#define HOSTIF_PRODUCT_ID_VER_HI  3  // sw version high   (0..255)
#define HOSTIF_PRODUCT_ID_VER_MID 3  // sw version middle (0..255)
#define HOSTIF_PRODUCT_ID_VER_LOW 0  // sw version low    (0..255)
#define HOSTIF_PRODUCT_ID_DATE_Y  7  // sw release year   (0..99)
#define HOSTIF_PRODUCT_ID_DATE_M  11 // sw release month  (1..12)
#define HOSTIF_PRODUCT_ID_DATE_D  21  // sw release day    (1..31) (>128 = pre-release number)
#define HOSTIF_PRODUCT_ID_HW_HI   1  // hw version high   (0..255)
#define HOSTIF_PRODUCT_ID_HW_MID  1  // hw version high   (0..255)
#define HOSTIF_PRODUCT_ID_HW_LOW  1  // hw version high   (0..255)
/* Same string is repeated in the #define below, in ASCII format */
/* to provide a way to recognize the version contained in .hex file */
#define HOSTIF_PRODUCT_ID_ASCII "SW RELEASE 3.3.0 071121"

/* auxiliary re-definition of product id, do not edit! */
#define HOSTIF_PRODUCT_STRING  \
{                           \
HOSTIF_PRODUCT_ID_VER_HI,   \
HOSTIF_PRODUCT_ID_VER_MID,  \
HOSTIF_PRODUCT_ID_VER_LOW,  \
HOSTIF_PRODUCT_ID_DATE_Y,   \
HOSTIF_PRODUCT_ID_DATE_M,   \
HOSTIF_PRODUCT_ID_DATE_D,   \
HOSTIF_PRODUCT_ID_HW_HI,    \
HOSTIF_PRODUCT_ID_HW_MID,   \
HOSTIF_PRODUCT_ID_HW_LOW    \
}

/* Byte offset for most important fields in the Application layer message/command */
#define HOSTIF_APP_GROUP_BYTE_INDEX        0
#define HOSTIF_APP_ID_BYTE_INDEX           1

/* Definitions for Host to Module */
/* GROUP - ID - PAR1              */
#define HOSTIF_GROUP_CMD_PLAYER_INFO    0x01
    #define REQ_PRODUCT_VERSION             0x01
    #define REQ_TEMPERATURE                 0x04
    #define REQ_STATE                       0x10
        #define POWER_MODE                      0x01
        #define PLAYER_MODE                     0x02
        #define LOADER_MODE                     0x04
        #define INSERT_MODE                     0x10  //JS changed from previously defined 0x08 according to CIS 0.09
//        #define ERROR_MODE                      0x10    in CIS 0.09 not present
        #define AVAILABLE_MODES                 0x1F  // internal
    #define REQ_MECH_PARAMETER              0x12
    #define REQ_MECH_MEASUREMENTS           0x13
    #define REQ_MISSING_ITEMS               0x16
    #define REQ_USB_HIGH_Z                  0x18

#define HOSTIF_GROUP_CMD_PLAYER_CONF    0x02
    #define CMD_WRITE_CFG_TABLE             0x01
    #define CMD_READ_CFG_TABLE              0x02
    #define CMD_WRITE_CFG_BITS              0x03

#define HOSTIF_GROUP_CMD_PLAYER_FUNC    0x03
    #define CMD_POWER_OFF                   0x01
    #define CMD_STOP                        0x02
    #define CMD_LOAD                        0x03
    #define CMD_EJECT                       0x04
    #define CMD_PLAY                        0x05
    #define CMD_PLAY_RESUME                 0x06
    #define CMD_PLAY_CONTINUE               0x08
    #define CMD_PAUSE                       0x0A
    #define CMD_SEARCH_FW                   0x0B
    #define CMD_SEARCH_BW                   0x0C