SdCardDriver.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Teknic, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef __SDCARDDRIVER_H__
#define __SDCARDDRIVER_H__

#include <stdint.h>
#include "PeripheralRoute.h"
#include "SerialBase.h"

namespace ClearCore {

class SdCardDriver : public SerialBase {
    friend class SysManager;

public:
#ifndef HIDE_FROM_DOXYGEN

    SdCardDriver() {};

    void SetErrorCode(uint8_t errorCode) {
        m_errorCode = errorCode;
    }

    bool IsInFault() {
        return (m_errorCode != 0);
    }
#endif // HIDE_FROM_DOXYGEN

private:
    uint8_t m_errorCode;

    SdCardDriver(const PeripheralRoute *misoPin,
                 const PeripheralRoute *ssPin,
                 const PeripheralRoute *sckPin,
                 const PeripheralRoute *mosiPin,
                 uint8_t peripheral);
};

} // ClearCore namespace

#endif // __SDCARDDRIVER_H__