src/platform/nxp/k32w/k32w0/RamStorage.h

/*
 *
 *    Copyright (c) 2022 Project CHIP Authors
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

#pragma once

#include <platform/internal/CHIPDeviceLayerInternal.h>

#include "PDM.h"
#include "ram_storage.h"

namespace chip {
namespace DeviceLayer {
namespace Internal {

class RamStorage;

/**
 *
 * This class describes a RAM storage key wrapper.
 */
struct RamStorageKey
{
    RamStorageKey(RamStorage * storage, uint8_t keyId, uint8_t internalId);

    CHIP_ERROR Read(uint8_t * buf, uint16_t & sizeToRead) const;
    CHIP_ERROR Write(const uint8_t * buf, uint16_t length);
    CHIP_ERROR Delete();

    static uint16_t GetInternalId(uint8_t keyId, uint8_t internalId) { return static_cast<uint16_t>(keyId) << 8 | internalId; }

private:
    RamStorage * mStorage;
    uint16_t mId;
};

/**
 *
 * This class manages a RAM buffer and its operations.
 * All operations on the buffer are protected by a mutex.
 */
class RamStorage
{
public:
    using Buffer = ramBufferDescriptor;

    static constexpr uint16_t kRamBufferInitialSize = 512;

    RamStorage(uint16_t aPdmId, const char * name) : mPdmId(aPdmId), mBuffer(nullptr), mName(name) {}

    CHIP_ERROR Init(uint16_t aInitialSize, bool extendedSearch = false);
    void FreeBuffer();
    Buffer * GetBuffer() const { return mBuffer; }
    const char * GetName() const { return mName; }
    CHIP_ERROR Read(uint16_t aKey, int aIndex, uint8_t * aValue, uint16_t * aValueLength) const;
    CHIP_ERROR Write(uint16_t aKey, const uint8_t * aValue, uint16_t aValueLength);
    CHIP_ERROR Delete(uint16_t aKey, int aIndex);
    void OnFactoryReset();

private:
    CHIP_ERROR MapStatusToChipError(rsError rsStatus) const;
    CHIP_ERROR MapPdmStatusToChipError(PDM_teStatus status) const;

    uint16_t mPdmId;
    Buffer * mBuffer;
    const char * mName;
    bool mExtendedSearch;
};

} // namespace Internal
} // namespace DeviceLayer
} // namespace chip