bdpart.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 * Copyright (C) 2009, 2012 embedded brains GmbH & Co. KG
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef RTEMS_BDPART_H
#define RTEMS_BDPART_H
 
#include <uuid/uuid.h>
 
#include <rtems.h>
#include <rtems/blkdev.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define RTEMS_BDPART_MBR_EMPTY 0x0U
 
#define RTEMS_BDPART_MBR_FAT_12 0x1U
 
#define RTEMS_BDPART_MBR_FAT_16 0x4U
 
#define RTEMS_BDPART_MBR_FAT_16_LBA 0xeU
 
#define RTEMS_BDPART_MBR_FAT_32 0xbU
 
#define RTEMS_BDPART_MBR_FAT_32_LBA 0xcU
 
#define RTEMS_BDPART_MBR_EXTENDED 0x5U
 
#define RTEMS_BDPART_MBR_DATA 0xdaU
 
#define RTEMS_BDPART_MBR_GPT 0xeeU
 
#define RTEMS_BDPART_MBR_FLAG_ACTIVE 0x80U
 
#define RTEMS_BDPART_PARTITION_NUMBER_HINT 16
 
typedef struct rtems_bdpart_partition {
  rtems_blkdev_bnum begin;
 
  rtems_blkdev_bnum end;
 
  uuid_t type;
 
  uuid_t id;
 
  uint64_t flags;
} rtems_bdpart_partition;
 
typedef enum {
  RTEMS_BDPART_FORMAT_MBR,
 
  RTEMS_BDPART_FORMAT_GPT
} rtems_bdpart_format_type;
 
typedef union {
  rtems_bdpart_format_type type;
 
  struct {
    rtems_bdpart_format_type type;
 
    uint32_t disk_id;
 
    bool dos_compatibility;
  } mbr;
 
  struct {
    rtems_bdpart_format_type type;
 
    uuid_t disk_id;
  } gpt;
} rtems_bdpart_format;
 
rtems_status_code rtems_bdpart_read(
  const char *disk_name,
  rtems_bdpart_format *format,
  rtems_bdpart_partition *partitions,
  size_t *count
);
 
void rtems_bdpart_sort( rtems_bdpart_partition *partitions, size_t count);
 
rtems_status_code rtems_bdpart_write(
  const char *disk_name,
  const rtems_bdpart_format *format,
  const rtems_bdpart_partition *partitions,
  size_t count
);
 
rtems_status_code rtems_bdpart_create(
  const char *disk_name,
  const rtems_bdpart_format *format,
  rtems_bdpart_partition *partitions,
  const unsigned *distribution,
  size_t count
);
 
rtems_status_code rtems_bdpart_register(
  const char *disk_name,
  const rtems_bdpart_partition *partitions,
  size_t count
);
 
rtems_status_code rtems_bdpart_register_from_disk( const char *disk_name);
 
rtems_status_code rtems_bdpart_unregister(
  const char *disk_name,
  const rtems_bdpart_partition *partitions,
  size_t count
);
 
void rtems_bdpart_dump( const rtems_bdpart_partition *partitions, size_t count);
 
void rtems_bdpart_to_partition_type( uint8_t mbr_type, uuid_t type);
 
bool rtems_bdpart_to_mbr_partition_type(
  const uuid_t type,
  uint8_t *mbr_type
);
 
#define RTEMS_BDPART_MBR_CYLINDER_SIZE 63
 
#define RTEMS_BDPART_NUMBER_SIZE 4
 
#define RTEMS_BDPART_BLOCK_SIZE 512
 
#define RTEMS_BDPART_MBR_TABLE_ENTRY_SIZE 16
 
#define RTEMS_BDPART_MBR_OFFSET_TABLE_0 446
 
#define RTEMS_BDPART_MBR_OFFSET_TABLE_1 \
  (RTEMS_BDPART_MBR_OFFSET_TABLE_0 + RTEMS_BDPART_MBR_TABLE_ENTRY_SIZE)
 
#define RTEMS_BDPART_MBR_OFFSET_DISK_ID 440
 
#define RTEMS_BDPART_MBR_OFFSET_SIGNATURE_0 510
 
#define RTEMS_BDPART_MBR_OFFSET_SIGNATURE_1 511
 
#define RTEMS_BDPART_MBR_SIGNATURE_0 0x55U
 
#define RTEMS_BDPART_MBR_SIGNATURE_1 0xaaU
 
#define RTEMS_BDPART_MBR_OFFSET_BEGIN 8
 
#define RTEMS_BDPART_MBR_OFFSET_SIZE 12
 
#define RTEMS_BDPART_MBR_OFFSET_TYPE 4
 
#define RTEMS_BDPART_MBR_OFFSET_FLAGS 0
 
static inline uint8_t rtems_bdpart_mbr_partition_type(
  const uuid_t type
)
{
  return type [0];
}
 
rtems_status_code rtems_bdpart_get_disk_data(
  const char *disk_name,
  int *fd_ptr,
  rtems_disk_device **dd_ptr,
  rtems_blkdev_bnum *disk_end
);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* RTEMS_BDPART_H */