resourcemgmt/hwresourcesmgr/include/HWRMFmTxClientServer.h
changeset 0 4e1aa6a622a0
equal deleted inserted replaced
-1:000000000000 0:4e1aa6a622a0
       
     1 /*
       
     2 * Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 /**
       
    22  @file
       
    23  @internalTechnology 
       
    24 */
       
    25 
       
    26 #ifndef HWRMFMTXCLIENTSERVER_H
       
    27 #define HWRMFMTXCLIENTSERVER_H
       
    28 
       
    29 // INCLUDES
       
    30 #include <hwrm/hwrmfmtxdata.h>
       
    31 
       
    32 // CONSTANTS
       
    33 const TInt KHWRMFmTxSubResourceCount(1);   
       
    34 
       
    35 
       
    36 // MACROS
       
    37 // None
       
    38 
       
    39 // DATA TYPES
       
    40 
       
    41 // Data packages for commands
       
    42 typedef TPckgBuf<TRtPlusTag>   THWRMRtPlusTagCmdPackage;
       
    43 
       
    44 // Opcodes used in message passing between client and server
       
    45 // FM Tx opcodes start at 4000
       
    46 enum THWRMFmTxServRequest
       
    47     {	
       
    48 	/**
       
    49 	* Enables FM Tx with specified frequency 
       
    50 	* 
       
    51 	* parameters:
       
    52 	* 0: TInt - Tx frequency in kHz
       
    53 	*/
       
    54 	EHWRMFmTxOn = 4000,
       
    55 
       
    56 	/**
       
    57 	* Disables FM Tx immediately.
       
    58 	* 
       
    59 	* parameters:
       
    60 	* None
       
    61 	*/
       
    62 	EHWRMFmTxOff,
       
    63 
       
    64 	/**
       
    65 	* Sets FM Tx frequency.
       
    66 	* 
       
    67 	* parameters:
       
    68 	* 0: TInt - Tx frequency in kHz
       
    69 	*/
       
    70 	EHWRMFmTxSetFreq,
       
    71 
       
    72 	/**
       
    73 	* Sets Tx frequency to next suggested clear frequency
       
    74 	* 
       
    75 	* parameters:
       
    76 	* 0: TInt - clear Tx frequency in kHz
       
    77 	*/
       
    78 	EHWRMFmTxSetNextClearFreq,
       
    79 	
       
    80 	/**
       
    81 	* Enables FM Tx automatic frequency mode
       
    82 	* 
       
    83 	* parameters:
       
    84 	* None
       
    85 	*/	
       
    86 	EHWRMFmTxAutoFreqOn,
       
    87 
       
    88 	/**
       
    89 	* Sets FM Tx RDS PTY
       
    90 	* 
       
    91 	* parameters:
       
    92 	* 0: TFmTxRdsProgrammeType - PTY
       
    93 	*/	
       
    94 	EHWRMFmTxSetRdsPty,
       
    95 	
       
    96 	/**
       
    97 	* Sets FM Tx RDS PTYN
       
    98 	* 
       
    99 	* parameters:
       
   100 	* 0: TFmTxRdsProgrammeTypeName - PTYN
       
   101 	*/	
       
   102 	EHWRMFmTxSetRdsPtyn,
       
   103 	
       
   104 	/**
       
   105 	* Sets FM Tx RDS MS
       
   106 	* 
       
   107 	* parameters:
       
   108 	* 0: TBool - Music/Speech flag
       
   109 	*/	
       
   110 	EHWRMFmTxSetRdsMs,
       
   111 	
       
   112 	/**
       
   113 	* Sets FM Tx RDS language ID
       
   114 	* 
       
   115 	* parameters:
       
   116 	* 0: TRdsLanguageIdType - Language ID
       
   117 	*/	
       
   118 	EHWRMFmTxSetRdsLanguageId,
       
   119 	
       
   120     /**
       
   121   	* Resets RDS data to defaults.
       
   122     *
       
   123 	* parameters:
       
   124 	* None
       
   125   	*/
       
   126     EHWRMFmTxClearRdsData,
       
   127     
       
   128 	/**
       
   129 	* Sets FM Tx RDS Radiotext
       
   130 	* 
       
   131 	* parameters:
       
   132 	* 0: TDes8 - Radiotext
       
   133 	*/	
       
   134 	EHWRMFmTxSetRadiotext,
       
   135 	
       
   136 	/**
       
   137 	* Sets FM Tx RDS Radiotext+
       
   138 	* 
       
   139 	* parameters:
       
   140 	* 0: TDes8 - Radiotext
       
   141 	* 1: TRtPlusContentType - Radiotext content type
       
   142 	*/		
       
   143 	EHWRMFmTxSetRadiotextPlus1,
       
   144 	
       
   145 	/**
       
   146 	* Sets FM Tx RDS Radiotext+
       
   147 	* 
       
   148 	* parameters:
       
   149 	* 0: TDes8 - Radiotext
       
   150 	* 1: TRtPlusTag - Radiotext tag
       
   151 	*/		
       
   152 	EHWRMFmTxSetRadiotextPlus2,
       
   153 	
       
   154 	/**
       
   155 	* Sets FM Tx RDS Radiotext+
       
   156 	* 
       
   157 	* parameters:
       
   158 	* 0: TDes8 - Radiotext
       
   159 	* 1: TRtPlusTag - Radiotext tag
       
   160 	* 2: TRtPlusTag - Radiotext tag	
       
   161 	*/		
       
   162 	EHWRMFmTxSetRadiotextPlus3,  
       
   163     
       
   164     /**
       
   165   	* Clears Radiotext data
       
   166     *
       
   167 	* parameters:
       
   168 	* None
       
   169   	*/    
       
   170     EHWRMFmTxClearRtData,
       
   171 	
       
   172 	/**
       
   173   	* Reserves FM Tx.
       
   174   	*
       
   175   	* parameters:
       
   176   	* 0: TBool - ForceNoCCoeEnv flag
       
   177   	*/
       
   178   	EHWRMFmTxReserve,
       
   179   	
       
   180   	/**
       
   181   	* Releases FM Tx.
       
   182     *
       
   183 	* parameters:
       
   184 	* None
       
   185   	*/
       
   186     EHWRMFmTxRelease,
       
   187 	
       
   188 	/**
       
   189 	* Get FM Tx frequency range
       
   190 	*
       
   191 	* parameters:
       
   192 	* 0: TPckgBuf<TFmTxFrequencyRange> On return, the frequency range
       
   193 	*/
       
   194 	EHWRMFmTxGetFreqRange,
       
   195 
       
   196 	/**
       
   197 	* Gets next suggested clear frequency
       
   198 	* 
       
   199 	* parameters:
       
   200 	* 0: TInt - clear Tx frequency in kHz
       
   201 	*/
       
   202 	EHWRMFmTxGetNextClearFreq,
       
   203 
       
   204 	/**
       
   205 	* Gets next suggested clear frequency
       
   206 	* 
       
   207 	* parameters:
       
   208 	* 0: TClearFrequencyArray - fixed size array of 10 clear Tx frequencies in kHz
       
   209 	*/
       
   210 	EHWRMFmTxGetNextClearFreqArray,
       
   211 
       
   212 	/**
       
   213 	* Cancels previous EHWRMFmTxGetNextClearFreq or EHWRMFmTxGetNextClearFreqArray
       
   214 	*/	
       
   215 	EHWRMFmTxCancelGetNextClearFreq,
       
   216 	
       
   217 	/**
       
   218 	* Cancels previous EHWRMFmTxSetNextClearFreq
       
   219 	*/	
       
   220 	EHWRMFmTxCancelSetNextClearFreq,   
       
   221 	
       
   222     /**
       
   223 	* Cleans up the FM Tx service so that session can be closed.
       
   224     *
       
   225    	* parameters:
       
   226    	* None
       
   227 	*/
       
   228    	EHWRMFmTxCleanup,
       
   229 
       
   230    	/**
       
   231    	* Disables FM Tx automatic frequency mode
       
   232    	* 
       
   233    	* parameters:
       
   234    	* None
       
   235    	*/	
       
   236    	EHWRMFmTxAutoFreqOff,
       
   237     
       
   238     EHWRMEndOfFmTxOpCodes
       
   239     };
       
   240 
       
   241 
       
   242 // FUNCTION PROTOTYPES
       
   243 // None
       
   244 
       
   245 // FORWARD DECLARATIONS
       
   246 // None
       
   247 
       
   248 // CLASS DECLARATION
       
   249 // None
       
   250 
       
   251 #endif  // HWRMFMTXCLIENTSERVER_H
       
   252             
       
   253 // End of File