Diag Update Service

API Reference

---

The diag update service APIs are used by applications to handle transfer requests from UDS clients. The diag update service includes the TransferData(0x36), RequestTransferExit(0x37), and RequestFileTransfer(0x38) services.

IPC interfaces binding

All functions of this API are provided by the tafDiagSvc platform service.

The following example illustrates how to bind to the diag update service.

bindings:
{
     clientExe.clientComponent.taf_diagUpdate -> tafDiagSvc.taf_diagUpdate
}

Request file transfer

After getting a reference, an application registers a file transfer handler using taf_diagUpdate_AddRxFileXferMsgHandler(). Once a file transfer request message is received, the handler will be called indicating the new message.

diagFileXferMsgRef = taf_diagUpdate_AddRxFileXferMsgHandler( diagUpdateSvcRef,
         fileXferMsgHandler, NULL );

An application can get a file path and name, and length by using taf_diagUpdate_GetFilePathAndName().

result = taf_diagUpdate_GetFilePathAndName( rxMsgRef,
         (uint8_t *)filePathAndName, &fileLen );
if (result != LE_OK)
{
     LE_ERROR("Fail to get file path and name, and length.");
     return result;
}

An application can set the file position by using taf_diagUpdate_SetFilePosition().

result = taf_diagUpdate_SetFilePosition(rxMsgRef, sizeOfFilePosition);
if (result != LE_OK)
{
     LE_ERROR("Fail to set file position as response: %d", result);
     return result;
}

An application can set the file size or directory information length by using taf_diagUpdate_SetFileSizeOrDirInfoLength().

result = taf_diagUpdate_SetFileSizeOrDirInfoLength(rxMsgRef,
                                                   fileSizeUncompressedOrDirInfoLength,
                                                   fileSizeCompressed);
if (result != LE_OK)
{
     LE_ERROR("Fail to set file size or dir info len as response: %d", result);
     return result;
}

An application can send a file transfer response by using taf_diagUpdate_SendFileXferResp().

result = taf_diagUpdate_SendFileXferResp(rxMsgRef, TAF_DIAGUPDATE_FILE_XFER_NO_ERROR);
if (result != LE_OK)
{
     LE_ERROR("Fail to send response.");
     return result;
}

The following APIs are provided for request file transfer.

• taf_diagUpdate_AddRxFileXferMsgHandler() – Adds a handler function for the specified event.
• taf_diagUpdate_RemoveRxFileXferMsgHandler() – Removes a handler function for the specified event.
• taf_diagUpdate_GetFilePathAndName() – Gets the file path and name.
• taf_diagUpdate_GetDataFormatID() – Gets the data format ID.
• taf_diagUpdate_GetUnCompFileSize() – Gets the size of the uncompressed file.
• taf_diagUpdate_GetCompFileSize() – Gets the size of the compressed file.
• taf_diagUpdate_SetFilePosition() – Set the file position into a response message.
• taf_diagUpdate_SetFileSizeOrDirInfoLength() – Set the file size or directory info length into a response message.
• taf_diagUpdate_SendFileXferResp() – Sends a response message for the file transfer message.

Transfer data

An application registers a transfer data handler using taf_diagUpdate_AddRxXferDataMsgHandler(). Once a transfer data request message is received, the handler will be called indicating the new message.

diagXferDataMsgRef = taf_diagUpdate_AddRxXferDataMsgHandler( diagUpdateSvcRef,
         xferDataMsgHandler, NULL );

An application can get the data length and payload by using taf_diagUpdate_GetXferDataParamRecLen() and taf_diagUpdate_GetXferDataParamRec() referring to the following sample code snippets.

result = taf_diagUpdate_GetXferDataParamRecLen( rxMsgRef, (uint16_t *)&xferDataLen);
if (result != LE_OK)
{
     LE_ERROR("Fail to get data length.");
     return result;
}

result = taf_diagUpdate_GetXferDataParamRec( rxMsgRef, xferData, &xferDataLen);
if (result != LE_OK)
{
     LE_ERROR("Fail to get data payload.");
     return result;
}

An application can send a transfer data response by using taf_diagUpdate_SendXferDataResp().

result = taf_diagUpdate_SendXferDataResp( rxMsgRef, TAF_DIAGUPDATE_XFER_DATA_NO_ERROR , NULL, 0);
if (result != LE_OK)
{
   LE_ERROR("Fail to send response.");
   return result;
}

The following APIs are provided for transfer data.

• taf_diagUpdate_AddRxXferDataMsgHandler() – Adds a handler function for the specified event.
• taf_diagUpdate_RemoveRxXferDataMsgHandler() – Removes a handler function for the specified event.
• taf_diagUpdate_GetblockSeqCount() – Gets the block sequence counter.
• taf_diagUpdate_GetXferDataParamRecLen() – Gets the data length.
• taf_diagUpdate_GetXferDataParamRec() – Gets the data payload.
• taf_diagUpdate_SendXferDataResp() – Sends a response message for the transfer data message.

Request transfer exit

An application registers a transfer exit handler using taf_diagUpdate_AddRxXferExitMsgHandler(). Once a transfer exit request message is received, the handler will be called indicating the new message.

diagXferExitMsgRef = taf_diagUpdate_AddRxXferExitMsgHandler( diagUpdateSvcRef,
         xferExitMsgHandler, NULL );

An application can send a transfer exit response by using taf_diagUpdate_SendXferDataResp().

result = taf_diagUpdate_SendXferExitResp( rxMsgRef, TAF_DIAGUPDATE_XFER_EXIT_NO_ERROR, NULL, 0 );
if (result != LE_OK)
{
     LE_ERROR("Fail to send response.");
     return result;
}

The following APIs are provided for request transfer exit.

• taf_diagUpdate_AddRxXferExitMsgHandler() – Adds a handler function for the specified event.
• taf_diagUpdate_RemoveRxXferExitMsgHandler() – Removes a handler function for the specified event.
• taf_diagUpdate_GetXferExitParamRec() – Gets the transfer request parameter record.
• taf_diagUpdate_SendXferExitResp() – Sends a response message for the transfer exit message.

The following APIs are provided for service reference.

• taf_diagUpdate_GetService() – Gets the reference to a diag update service.
• taf_diagUpdate_RemoveSvc() – Removes the daig update service.

---