summaryrefslogtreecommitdiff
path: root/src/drivers/include/storage.hpp
blob: a92692619d0d9f85963023128a3cd32ea16231f3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/*
 * Copyright 2023 jacqueline <me@jacqueline.id.au>
 *
 * SPDX-License-Identifier: GPL-3.0-only
 */

#pragma once

#include <memory>

#include "driver/sdmmc_types.h"
#include "driver/sdspi_host.h"
#include "esp_err.h"
#include "esp_vfs_fat.h"
#include "ff.h"
#include "result.hpp"

#include "gpios.hpp"

namespace drivers {

extern const char* kStoragePath;

class SdStorage {
 public:
  enum Error {
    FAILED_TO_INIT,
    /** We couldn't interact with the SD card at all. Is it missing? */
    FAILED_TO_READ,
    /** We couldn't mount the SD card. Is it formatted? */
    FAILED_TO_MOUNT,
  };

  static auto Create(IGpios* gpio) -> cpp::result<SdStorage*, Error>;

  SdStorage(IGpios* gpio,
            esp_err_t (*do_transaction)(sdspi_dev_handle_t, sdmmc_command_t*),
            sdspi_dev_handle_t handle_,
            std::unique_ptr<sdmmc_host_t> host_,
            std::unique_ptr<sdmmc_card_t> card_,
            FATFS* fs_);
  ~SdStorage();

  auto HandleTransaction(sdspi_dev_handle_t handle, sdmmc_command_t* cmdinfo)
      -> esp_err_t;

  auto GetFs() -> FATFS*;

  // Not copyable or movable.
  // TODO: maybe this could be movable?
  SdStorage(const SdStorage&) = delete;
  SdStorage& operator=(const SdStorage&) = delete;

 private:
  IGpios* gpio_;

  esp_err_t (*do_transaction_)(sdspi_dev_handle_t, sdmmc_command_t*) = nullptr;

  // SPI and SD driver info
  sdspi_dev_handle_t handle_;
  std::unique_ptr<sdmmc_host_t> host_;
  std::unique_ptr<sdmmc_card_t> card_;

  // Filesystem info
  FATFS* fs_ = nullptr;
};

}  // namespace drivers