kernel/eka/drivers/pbus/mmc/rpmbstack.cpp
changeset 287 ddfd5aa0d58f
equal deleted inserted replaced
286:48e57fb1237e 287:ddfd5aa0d58f
       
     1 // Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of the License "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 /**
       
    17  @file
       
    18  @internalComponent
       
    19  @prototype
       
    20 */
       
    21 
       
    22 #include <drivers/mmc.h>
       
    23 #include <drivers/rpmbpacket.h>
       
    24 
       
    25 #include "OstTraceDefinitions.h"
       
    26 #ifdef OST_TRACE_COMPILER_IN_USE
       
    27 #include "../../../include/drivers/locmedia_ost.h"
       
    28 #ifdef __VC32__
       
    29 #pragma warning(disable: 4127) // disabling warning "conditional expression is constant"
       
    30 #endif
       
    31 #include "rpmbstackTraces.h"
       
    32 #endif
       
    33 
       
    34 TMMCErr DMMCStack::CIMRpmbAccessSM()
       
    35     {
       
    36 enum TStates
       
    37         {
       
    38         EStBegin,
       
    39         EStEnd
       
    40         };
       
    41 
       
    42     DMMCSession& s=Session();
       
    43 
       
    44     //Extract the RPMB request type from the command. JEDEC specify this to be situated
       
    45     //at offset 0 in the packet. When accessing the hardware, this is reversed and is 
       
    46     //at offset 511
       
    47 	TUint8 requestType = * (s.Command().iDataMemoryP + KRpmbRequestLsbOffset);
       
    48 	
       
    49 	//There are 5 possible rpmb request types that can be passed through the state machines:
       
    50 	//
       
    51 	//Authentication Key programming request:     KRpmbRequestWriteKey = 0x001
       
    52 	//Reading of the write counter value request: KRpmbRequestReadWriteCounter = 0x0002;
       
    53 	//Authenticated data write request:           KRpmbRequestWriteData = 0x0003;
       
    54 	//Authenticated data read request:            KRpmbRequestReadData = 0x0004;
       
    55 	//Result read request:                        KRpmbRequestReadResultRegister = 0x0005;
       
    56 	//
       
    57 
       
    58 	SMF_BEGIN
       
    59 	
       
    60     switch (requestType)
       
    61         {
       
    62         case KRpmbRequestWriteKey:
       
    63 			SMF_INVOKES(CIMRpmbWriteAuthenticationKeySMST, EStEnd);
       
    64         case KRpmbRequestReadWriteCounter:
       
    65 			SMF_INVOKES(CIMRpmbReadWrCounterSMST, EStEnd);
       
    66         case KRpmbRequestWriteData:
       
    67 			SMF_INVOKES(CIMRpmbWriteSMST, EStEnd);
       
    68         case KRpmbRequestReadData:
       
    69  			SMF_INVOKES(CIMRpmbReadSMST, EStEnd);
       
    70         default:
       
    71             break;   
       
    72         }
       
    73 
       
    74     SMF_END
       
    75 }
       
    76 
       
    77 
       
    78 TMMCErr DMMCStack::CIMRpmbWriteAuthenticationKeySM()
       
    79     {
       
    80     enum TStates
       
    81         {
       
    82         EStBegin,   // Write key request
       
    83         EStSetupReadRequest,
       
    84         EStReadResult,
       
    85         EStError,
       
    86         EStEnd
       
    87         };
       
    88 
       
    89     DMMCSession& s=Session();
       
    90 
       
    91 	SMF_BEGIN
       
    92 
       
    93         //
       
    94         // Setup write request
       
    95         // CMD23 Reliable Write = 1 Block Count = 1
       
    96         // CMD25
       
    97         // 
       
    98         s.SetupRpmbSendRequest(ETrue);
       
    99 		//
       
   100         // KMMCErrByPass is routinely thrown in the ReadWriteBlocks state machine. 
       
   101         // It is thrown to indicate that the current command in the state machine is not CMD42(lock/unlock)
       
   102         // We need to trap this error here to stop the RPMB state machines from unravelling and passing
       
   103         // the error upwards. 
       
   104         //	
       
   105 		m.SetTraps(KMMCErrBypass);
       
   106 		
       
   107 		OstTrace0(TRACE_FLOW, DMMCSTACK_CIMRPMBWRITEAUTHENTICATIONKEYSM1, "RPMB: Write Key State Machine - send write key request packet");
       
   108         __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Write Key State Machine - send write key request packet"));
       
   109         
       
   110         SMF_INVOKES(CIMReadWriteBlocksSMST, EStSetupReadRequest);
       
   111 
       
   112     SMF_STATE(EStSetupReadRequest)
       
   113 
       
   114         OstTrace0(TRACE_FLOW, DMMCSTACK_CIMRPMBWRITEAUTHENTICATIONKEYSM2, "RPMB: Write Key State Machine - sent write key request packet");
       
   115         __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Write Key State Machine - sent write key request packet"));
       
   116     
       
   117 		if (err != KMMCErrNone)
       
   118 			{
       
   119 		    OstTrace1(TRACE_FLOW, DMMCSTACK_CIMRPMBWRITEAUTHENTICATIONKEYSM3, "RPMB: Write Key State Machine - sent write key request packet error = %d", err);
       
   120 		    __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Write Key State Machine - sent write key request packet error = %d", err));
       
   121 			SMF_GOTOS(EStError);
       
   122 			}
       
   123 		// 
       
   124         // Setup read result register request
       
   125         // CMD23 Reliable Write = 0 Block Count = 1
       
   126         // CMD25
       
   127         //
       
   128 		s.SetupRpmbSendReadResultRegisterRequest();
       
   129 		OstTrace0(TRACE_FLOW, DMMCSTACK_CIMRPMBWRITEAUTHENTICATIONKEYSM4, "RPMB: Write Key State Machine - send read result register request packet");
       
   130 		__KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Write Key State Machine - send read result register request packet"));
       
   131         SMF_INVOKES(CIMReadWriteBlocksSMST, EStReadResult)
       
   132 
       
   133     SMF_STATE(EStReadResult)
       
   134 
       
   135         OstTrace0(TRACE_FLOW, DMMCSTACK_CIMRPMBWRITEAUTHENTICATIONKEYSM5, "RPMB: Write Key State Machine - sent read result register request packet");
       
   136         __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Write Key State Machine - sent read result register request packet"));
       
   137 
       
   138         if (err != KMMCErrNone)
       
   139             {
       
   140             OstTrace1(TRACE_FLOW, DMMCSTACK_CIMRPMBWRITEAUTHENTICATIONKEYSM6, "RPMB: Write Key State Machine - sent read result register request packet error = %d", err);
       
   141             __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Write Key State Machine - sent read result register request packet error = %d", err));
       
   142             SMF_GOTOS(EStError);
       
   143             }
       
   144         //
       
   145         // Setup read response
       
   146         // CMD23 Reliable Write = 0 Block Count = 1
       
   147         // CMD18
       
   148         //        
       
   149         s.SetupRpmbReceiveResponse();
       
   150         OstTrace0(TRACE_FLOW, DMMCSTACK_CIMRPMBWRITEAUTHENTICATIONKEYSM7, "RPMB: Write Key State Machine - get read packet");
       
   151         __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Write Key State Machine - get read packet"));
       
   152         SMF_INVOKES(CIMReadWriteBlocksSMST, EStEnd);
       
   153 
       
   154     SMF_STATE(EStError)
       
   155         SMF_RETURN(err);
       
   156 
       
   157     SMF_END
       
   158     }
       
   159 
       
   160 
       
   161 TMMCErr DMMCStack::CIMRpmbReadWrCounterSM()
       
   162     {
       
   163     enum TStates
       
   164         {
       
   165         EStBegin,   // Read counter request
       
   166         EStReadResult,
       
   167         EStError,
       
   168         EStEnd
       
   169         };
       
   170 
       
   171     DMMCSession& s=Session();
       
   172 
       
   173 	SMF_BEGIN
       
   174 	
       
   175         //
       
   176         // Setup write request
       
   177         // CMD23 Reliable Write = 0 Block Count = 1
       
   178         // CMD25
       
   179         // 
       
   180         s.SetupRpmbSendRequest(EFalse);
       
   181         m.SetTraps(KMMCErrBypass);
       
   182         
       
   183         OstTrace0(TRACE_FLOW, DMMCSTACK_CIMRPMBREADWRCOUNTERSM1, "RPMB: Read Write Counter State Machine - send read counter request packet");
       
   184         __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Read Write Counter State Machine - send read counter request packet"));
       
   185  
       
   186         SMF_INVOKES(CIMReadWriteBlocksSMST, EStReadResult)
       
   187 
       
   188     SMF_STATE(EStReadResult)
       
   189 
       
   190         OstTrace0(TRACE_FLOW, DMMCSTACK_CIMRPMBREADWRCOUNTERSM2, "RPMB: Read Write Counter State Machine - sent read counter request packet");
       
   191         __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Read Write Counter State Machine - sent read counter request packet"));
       
   192 
       
   193         if (err != KMMCErrNone)
       
   194             {
       
   195             OstTrace1(TRACE_FLOW, DMMCSTACK_CIMRPMBREADWRCOUNTERSM3, "RPMB: Read Write Counter State Machine - sent read counter request packet error = %d", err);
       
   196             __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Read Write Counter State Machine - sent read counter request packet error = %d", err));
       
   197             SMF_GOTOS(EStError);
       
   198             }
       
   199         //
       
   200         // Setup read response
       
   201         // CMD23 Reliable Write = 0 Block Count = 1
       
   202         // CMD18
       
   203         //        
       
   204         s.SetupRpmbReceiveResponse();
       
   205         OstTrace0(TRACE_FLOW, DMMCSTACK_CIMRPMBREADWRCOUNTERSM4, "RPMB: Read Write Counter State Machine - get read packet");
       
   206         __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Read Write Counter State Machine - get read packet"));
       
   207        SMF_INVOKES(CIMReadWriteBlocksSMST, EStEnd);
       
   208 
       
   209     SMF_STATE(EStError)
       
   210         SMF_RETURN(err);
       
   211 
       
   212     SMF_END
       
   213     }
       
   214 
       
   215 
       
   216 TMMCErr DMMCStack::CIMRpmbWriteSM()
       
   217     {
       
   218     enum TStates
       
   219         {
       
   220         EStBegin,   // Write data request
       
   221         EStSetupReadRequest,
       
   222         EStReadResult,
       
   223         EStError,
       
   224         EStEnd
       
   225         };
       
   226 
       
   227     DMMCSession& s=Session();
       
   228 
       
   229 	SMF_BEGIN
       
   230 
       
   231         //
       
   232         // Setup write request
       
   233         // CMD23 Reliable Write = 1 Block Count = 1
       
   234         // CMD25
       
   235         // 
       
   236         s.SetupRpmbSendRequest(ETrue);
       
   237 	    m.SetTraps(KMMCErrBypass);
       
   238 	    
       
   239 	    OstTrace0(TRACE_FLOW, DMMCSTACK_CIMRPMBWRITESM1, "RPMB: Write State Machine - send write request packet");
       
   240 	    __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Write State Machine - send write request packet"));
       
   241 
       
   242 	    SMF_INVOKES(CIMReadWriteBlocksSMST, EStSetupReadRequest);
       
   243 
       
   244     SMF_STATE(EStSetupReadRequest)
       
   245 	    
       
   246 	    OstTrace0(TRACE_FLOW, DMMCSTACK_CIMRPMBWRITESM2, "RPMB: Write State Machine - sent write request packet");
       
   247 	    __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Write State Machine - sent write request packet"));
       
   248 
       
   249 		if (err != KMMCErrNone)
       
   250 			{
       
   251 		    OstTrace1(TRACE_FLOW, DMMCSTACK_CIMRPMBWRITESM3, "RPMB: Write State Machine - sent write request packet error = %d", err);
       
   252 		    __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Write State Machine - sent write request packet error = %d", err));
       
   253 			SMF_GOTOS(EStError);
       
   254 			}	
       
   255         // 
       
   256         // Setup read result register request
       
   257         // CMD23 Reliable Write = 0 Block Count = 1
       
   258         // CMD25
       
   259         //
       
   260         s.SetupRpmbSendReadResultRegisterRequest();
       
   261         OstTrace0(TRACE_FLOW, DMMCSTACK_CIMRPMBWRITESM4, "RPMB: Write State Machine - send read result register request packet");
       
   262         __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Write State Machine - send read result register request packet"));
       
   263         SMF_INVOKES(CIMReadWriteBlocksSMST, EStReadResult)
       
   264 
       
   265     SMF_STATE(EStReadResult)
       
   266         
       
   267         OstTrace0(TRACE_FLOW, DMMCSTACK_CIMRPMBWRITESM5, "RPMB: Write State Machine - sent read result register request packet");
       
   268         __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Write State Machine - sent read result register request packet"));
       
   269 
       
   270         if (err != KMMCErrNone)
       
   271             {
       
   272             OstTrace1(TRACE_FLOW, DMMCSTACK_CIMRPMBWRITESM6, "RPMB: Write State Machine - sent read result register request packet error = %d", err);
       
   273             __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Write State Machine - sent read result register request packet error = %d", err));
       
   274             SMF_GOTOS(EStError);
       
   275             }
       
   276         //
       
   277         // Setup read response
       
   278         // CMD23 Reliable Write = 0 Block Count = 1
       
   279         // CMD18
       
   280         //        
       
   281         s.SetupRpmbReceiveResponse();
       
   282         OstTrace0(TRACE_FLOW, DMMCSTACK_CIMRPMBWRITESM7, "RPMB: Write State Machine - get read packet");
       
   283         __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Write State Machine - get read packet"));
       
   284         SMF_INVOKES(CIMReadWriteBlocksSMST, EStEnd);
       
   285 
       
   286     SMF_STATE(EStError)
       
   287        SMF_RETURN(err);
       
   288 
       
   289     SMF_END
       
   290     }
       
   291 
       
   292 
       
   293 TMMCErr DMMCStack::CIMRpmbReadSM()
       
   294     {
       
   295     enum TStates
       
   296         {
       
   297         EStBegin,   // Read data request
       
   298         EStReadResult,
       
   299         EStError,
       
   300         EStEnd
       
   301         };
       
   302 
       
   303     DMMCSession& s=Session();
       
   304 
       
   305     SMF_BEGIN
       
   306          
       
   307         //
       
   308         // Setup write request
       
   309         // CMD23 Reliable Write = 0 Block Count = 1
       
   310         // CMD25
       
   311         // 
       
   312         s.SetupRpmbSendRequest(EFalse);
       
   313         m.SetTraps(KMMCErrBypass);
       
   314         
       
   315         OstTrace0(TRACE_FLOW, DMMCSTACK_CIMRPMBREADSM1, "RPMB: Read State Machine - send read request packet");
       
   316         __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Read State Machine - send read request packet"));
       
   317 
       
   318 		SMF_INVOKES(CIMReadWriteBlocksSMST, EStReadResult)
       
   319 
       
   320     SMF_STATE(EStReadResult)
       
   321         
       
   322         OstTrace0(TRACE_FLOW, DMMCSTACK_CIMRPMBREADSM2, "RPMB: Read State Machine - sent read request packet");
       
   323 		__KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Read State Machine - sent read request packet"));
       
   324 		
       
   325 		if (err != KMMCErrNone)
       
   326            {
       
   327            OstTrace1(TRACE_FLOW, DMMCSTACK_CIMRPMBREADSM3, "RPMB: Read State Machine - sent read request packet error = %d", err);
       
   328            __KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Read State Machine - sent read request packet error = %d", err));
       
   329            SMF_GOTOS(EStError);
       
   330            }
       
   331         //
       
   332         // Setup read response
       
   333         // CMD23 Reliable Write = 0 Block Count = 1
       
   334         // CMD18
       
   335         //        
       
   336 		s.SetupRpmbReceiveResponse();
       
   337 		OstTrace0(TRACE_FLOW, DMMCSTACK_CIMRPMBREADSM4, "RPMB: Read State Machine - get read packet");
       
   338 		__KTRACE_OPT(KPBUS1, Kern::Printf("RPMB: Read State Machine - get read packet"));
       
   339 		SMF_INVOKES(CIMReadWriteBlocksSMST, EStEnd);
       
   340 
       
   341     SMF_STATE(EStError)
       
   342         SMF_RETURN(err);
       
   343 
       
   344     SMF_END
       
   345     }
       
   346 
       
   347 TMMCErr DMMCStack::CIMRpmbAccessSMST(TAny* aStackP)
       
   348 	{return(static_cast<DMMCStack*>(aStackP)->CIMRpmbAccessSM());}
       
   349 TMMCErr DMMCStack::CIMRpmbWriteAuthenticationKeySMST(TAny* aStackP)
       
   350 	{return(static_cast<DMMCStack*>(aStackP)->CIMRpmbWriteAuthenticationKeySM());}
       
   351 TMMCErr DMMCStack::CIMRpmbReadWrCounterSMST(TAny* aStackP)
       
   352 	{return(static_cast<DMMCStack*>(aStackP)->CIMRpmbReadWrCounterSM());}
       
   353 TMMCErr DMMCStack::CIMRpmbWriteSMST(TAny* aStackP)
       
   354 	{return(static_cast<DMMCStack*>(aStackP)->CIMRpmbWriteSM());}
       
   355 TMMCErr DMMCStack::CIMRpmbReadSMST(TAny* aStackP)
       
   356 	{return(static_cast<DMMCStack*>(aStackP)->CIMRpmbReadSM());}