usb_msd.h

Go to the documentation of this file.

/*
 * Copyright (C) 2014 Gautier Hattenberger, Alexandre Bustico
 *
 * This file is part of paparazzi.
 *
 * paparazzi is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * paparazzi is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with paparazzi; see the file COPYING.  If not, write to
 * the Free Software Foundation, 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

/*
 * @file modules/loggers/sdlog_chibios/usb_msd.h
 *
 */

#pragma once

#include <ch.h>
#include <hal.h>
#include "std.h"

#ifndef PACK_STRUCT_BEGIN
#define PACK_STRUCT_BEGIN
#endif

#ifndef PACK_STRUCT_END
#define PACK_STRUCT_END
#endif

#ifndef PACK_STRUCT_STRUCT
#define PACK_STRUCT_STRUCT __attribute__((packed))
#endif

PACK_STRUCT_BEGIN typedef struct {
  uint32_t signature;
  uint32_t tag;
  uint32_t data_len;
  uint8_t flags;
  uint8_t lun;
  uint8_t scsi_cmd_len;
  uint8_t scsi_cmd_data[16];
} PACK_STRUCT_STRUCT msd_cbw_t PACK_STRUCT_END;

PACK_STRUCT_BEGIN typedef struct {
  uint32_t signature;
  uint32_t tag;
  uint32_t data_residue;
  uint8_t status;
} PACK_STRUCT_STRUCT msd_csw_t PACK_STRUCT_END;

PACK_STRUCT_BEGIN typedef struct {
  uint8_t byte[18];
} PACK_STRUCT_STRUCT msd_scsi_sense_response_t PACK_STRUCT_END;

PACK_STRUCT_BEGIN typedef struct {
  uint8_t peripheral;
  uint8_t removable;
  uint8_t version;
  uint8_t response_data_format;
  uint8_t additional_length;
  uint8_t sccstp;
  uint8_t bqueetc;
  uint8_t cmdque;
  uint8_t vendor_id[8];
  uint8_t product_id[16];
  uint8_t product_rev[4];
} PACK_STRUCT_STRUCT msd_scsi_inquiry_response_t PACK_STRUCT_END;

typedef enum {
  MSD_IDLE,
  MSD_READ_COMMAND_BLOCK,
  MSD_EJECTED
} msd_state_t;

typedef struct {
  USBDriver *usbp;

  BaseBlockDevice *bbdp;

  usbep_t bulk_ep;

  void (*rw_activity_callback)(bool);

  uint8_t short_vendor_id[8];

  uint8_t short_product_id[16];

  uint8_t short_product_version[4];

} USBMassStorageConfig;

typedef struct {
  const USBMassStorageConfig *config;
  binary_semaphore_t bsem;
  thread_t *thread;
  event_source_t evt_connected, evt_ejected;
  BlockDeviceInfo block_dev_info;
  msd_state_t state;
  msd_cbw_t cbw;
  msd_csw_t csw;
  msd_scsi_sense_response_t sense;
  msd_scsi_inquiry_response_t inquiry;
  bool result;
} USBMassStorageDriver;

#ifdef __cplusplus
extern "C" {
#endif

void msdInit(USBMassStorageDriver *msdp);

void msdStart(USBMassStorageDriver *msdp, const USBMassStorageConfig *config);

void msdStop(USBMassStorageDriver *msdp);

void msdConfigureHookI(USBMassStorageDriver *msdp);

bool msdRequestsHook(USBDriver *usbp);

#ifdef __cplusplus
}
#endif