Commit bf4a3218 authored by Greg Williams's avatar Greg Williams
Browse files

Implemented KineticAdminClient_UpdateFirmware.

parent a50c2c74

include/kinetic_types.h

+1 −0
Original line number Diff line number Diff line
@@ -193,6 +193,7 @@ typedef enum { 
    KINETIC_STATUS_DEVICE_LOCKED,           ///< The operation failed because the device is sercurely locked. An UNLOCK must be issued to unlock for use.

    KINETIC_STATUS_ACL_ERROR,               ///< A security operation failed due to bad ACL(s)

    KINETIC_STATUS_NOT_AUTHORIZED,          ///< Authorization failure

    KINETIC_STATUS_INVALID_FILE,            ///< Specified file does not exist or could not be read/writtten

    KINETIC_STATUS_COUNT                    ///< Number of status codes in KineticStatusDescriptor

} KineticStatus;

src/lib/kinetic_admin_client.c

+17 −14
Original line number Diff line number Diff line
@@ -218,10 +218,6 @@ KineticStatus KineticAdminClient_SetClusterVersion(KineticSession const * const 
    assert(session != NULL);

    assert(session->connection != NULL);



    KineticStatus status;

    status = KineticAuth_EnsureSslEnabled(&session->config);

    if (status != KINETIC_STATUS_SUCCESS) {return status;}



    KineticOperation* operation = KineticAllocator_NewOperation(session->connection);

    if (operation == NULL) {return KINETIC_STATUS_MEMORY_ERROR;}
@@ -229,16 +225,6 @@ KineticStatus KineticAdminClient_SetClusterVersion(KineticSession const * const 
    return KineticController_ExecuteOperation(operation, NULL);

}



KineticStatus KineticAdminClient_UpdateFirmware(KineticSession const * const session,

    char const * const fw_path)

{

    assert(session != NULL);

    assert(session->connection != NULL);

    (void)session;

    (void)fw_path;

    return KINETIC_STATUS_INVALID;

}



KineticStatus KineticAdminClient_SetACL(KineticSession const * const session,

        const char *ACLPath) {

    assert(session != NULL);
@@ -269,3 +255,20 @@ KineticStatus KineticAdminClient_SetACL(KineticSession const * const session, 


    return status;

}



KineticStatus KineticAdminClient_UpdateFirmware(KineticSession const * const session,

    char const * const fw_path)

{

    assert(session != NULL);

    assert(session->connection != NULL);



    KineticOperation* operation = KineticAllocator_NewOperation(session->connection);

    if (operation == NULL) {return KINETIC_STATUS_MEMORY_ERROR;}

    

    KineticStatus status = KineticOperation_BuildUpdateFirmware(operation, fw_path);

    if (status != KINETIC_STATUS_SUCCESS) {

        return status;

    }

    

    return KineticController_ExecuteOperation(operation, NULL);

}

src/lib/kinetic_operation.c

+106 −9
Original line number Diff line number Diff line
@@ -32,6 +32,7 @@ 
#include <stdlib.h>

#include <errno.h>

#include <sys/time.h>

#include <stdio.h>



#include "bus.h"

#include "acl.h"
@@ -140,16 +141,18 @@ static KineticStatus KineticOperation_SendRequestInner(KineticOperation* const o 
    };

    if (operation->entry != NULL && operation->sendValue) {

        header.valueLength = operation->entry->value.bytesUsed;

    }

    else {

        header.valueLength = 0;

    }

        if (header.valueLength > PDU_PROTO_MAX_LEN) {

        // Packed value exceeds max size.

        LOGF2("\nPacked value exceeds maximum size. Packed size is: %d, Max size is: %d", header.valueLength, PDU_PROTO_MAX_LEN);

            LOGF2("Value exceeds maximum size. Packed size is: %d, Max size is: %d", header.valueLength, PDU_PROTO_MAX_LEN);

            status = KINETIC_STATUS_BUFFER_OVERRUN;

            goto cleanup;

        }

    }

    else if (operation->value.len > 0) {

        header.valueLength = operation->value.len;

    }

    else {

        header.valueLength = 0;

    }



    uint32_t nboProtoLength = KineticNBO_FromHostU32(header.protobufLength);

    uint32_t nboValueLength = KineticNBO_FromHostU32(header.valueLength);
@@ -193,7 +196,12 @@ static KineticStatus KineticOperation_SendRequestInner(KineticOperation* const o 


    // Send the value/payload, if specified

    if (header.valueLength > 0) {

        if (operation->value.len == 0) {

            memcpy(&msg[offset], operation->entry->value.array.data, operation->entry->value.bytesUsed);

        }

        else {

            memcpy(&msg[offset], operation->value.data, operation->value.len);

        }

        offset += operation->entry->value.bytesUsed;

    }

    KINETIC_ASSERT((PDU_HEADER_LEN + header.protobufLength + header.valueLength) == offset);
@@ -870,8 +878,6 @@ void KineticOperation_BuildSetClusterVersion(KineticOperation* operation, int64_ 
    operation->request->command->body->setup->newClusterVersion = new_cluster_version;

    operation->request->command->body->setup->has_newClusterVersion = true;



    operation->request->command->body = &operation->request->message.body;



    operation->valueEnabled = false;

    operation->sendValue = false;

    operation->callback = &KineticOperation_SetClusterVersionCallback;
@@ -905,3 +911,94 @@ void KineticOperation_BuildSetACL(KineticOperation* const operation, 
    operation->sendValue = false;

    operation->callback = &KineticOperation_SetACLCallback;

}



KineticStatus KineticOperation_UpdateFirmwareCallback(KineticOperation* const operation, KineticStatus const status)

{

    KINETIC_ASSERT(operation != NULL);

    KINETIC_ASSERT(operation->connection != NULL);

    LOGF3("UpdateFirmwareCallback, with operation (0x%0llX) on connection (0x%0llX), status %d",

        operation, operation->connection, status);



    if (operation->value.data != NULL) {

        free(operation->value.data);

        memset(&operation->value, 0, sizeof(ByteArray));

    }

    

    return status;

}



KineticStatus KineticOperation_BuildUpdateFirmware(KineticOperation* const operation, const char* fw_path)

{

    KineticOperation_ValidateOperation(operation);



    KineticStatus status = KINETIC_STATUS_INVALID;

    FILE* fw_file = NULL;



    if (fw_path == NULL) {

        LOG0("ERROR: FW update file was NULL");

        status = KINETIC_STATUS_INVALID_FILE;

        goto cleanup;

    }



    fw_file = fopen(fw_path, "r");

    if (fw_file == NULL) {

        LOG0("ERROR: Specified FW update file could not be opened");

        return KINETIC_STATUS_INVALID_FILE;

        goto cleanup;

    }



    if (fseek(fw_file, 0L, SEEK_END) != 0) {

        LOG0("ERROR: Specified FW update file could not be seek");

        status = KINETIC_STATUS_INVALID_FILE;

        goto cleanup;

    }



    long len = ftell(fw_file);

    if (len < 1) {

        LOG0("ERROR: Specified FW update file could not be queried for length");

        status = KINETIC_STATUS_INVALID_FILE;

        goto cleanup;

    }

    if (fseek(fw_file, 0L, SEEK_SET) != 0) {

        LOG0("ERROR: Specified FW update file could not be seek back to start");

        status = KINETIC_STATUS_INVALID_FILE;

        goto cleanup;

    }



    operation->value.data = calloc(len, 1);

    if (operation->value.data == NULL) {

        LOG0("ERROR: Failed allocating memory to store FW update image");

        status = KINETIC_STATUS_MEMORY_ERROR;

        goto cleanup;

    }



    size_t readLen = fread(operation->value.data, 1, len, fw_file);

    if ((long)readLen != len) {

        LOGF0("ERROR: Expected to read %ld bytes from FW file, but read %zu", len, readLen);

        status = KINETIC_STATUS_INVALID_FILE;

        goto cleanup;

    }

    fclose(fw_file);



    operation->value.len = readLen;

    

    operation->request->message.command.header->messageType = KINETIC_PROTO_COMMAND_MESSAGE_TYPE_SETUP;

    operation->request->message.command.header->has_messageType = true;

    operation->request->command->body = &operation->request->message.body;

    

    operation->request->command->body->setup = &operation->request->message.setup;

    operation->request->command->body->setup->firmwareDownload = true;

    operation->request->command->body->setup->has_firmwareDownload = true;



    operation->valueEnabled = true;

    operation->sendValue = true;

    operation->callback = &KineticOperation_UpdateFirmwareCallback;



    return KINETIC_STATUS_SUCCESS;



cleanup:

    if (fw_file != NULL) {

        fclose(fw_file);

    }

    return status;

}

src/lib/kinetic_operation.h

+3 −0
Original line number Diff line number Diff line
@@ -88,4 +88,7 @@ void KineticOperation_BuildSetACL(KineticOperation* const operation, struct ACL 
KineticStatus KineticOperation_SetClusterVersionCallback(KineticOperation* const operation, KineticStatus const status);

void KineticOperation_BuildSetClusterVersion(KineticOperation* const operation, int64_t new_cluster_version);



KineticStatus KineticOperation_UpdateFirmwareCallback(KineticOperation* const operation, KineticStatus const status);

KineticStatus KineticOperation_BuildUpdateFirmware(KineticOperation* const operation, const char* fw_path);



#endif // _KINETIC_OPERATION_H

src/lib/kinetic_types.c

+1 −0
Original line number Diff line number Diff line
@@ -51,6 +51,7 @@ STATIC const char* KineticStatusDescriptor[] = { 
    "DEVICE_LOCKED",

    "ACL_ERROR",

    "NOT_AUTHORIZED",

    "KINETIC_STATUS_INVALID_FILE",

};



#ifdef TEST