1 /**************************************************************************** 2 * drivers/bch/bch.h 3 * 4 * Copyright (C) 2008-2009, 2014-2015 Gregory Nutt. All rights reserved. 5 * Author: Gregory Nutt <gnutt@nuttx.org> 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * 3. Neither the name NuttX nor the names of its contributors may be 18 * used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 28 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 31 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 32 * POSSIBILITY OF SUCH DAMAGE. 33 * 34 ****************************************************************************/ 35 36 #ifndef __DRIVERS_BCH_BCH_H 37 #define __DRIVERS_BCH_BCH_H 38 39 /**************************************************************************** 40 * Included Files 41 ****************************************************************************/ 42 43 #include <sys/types.h> 44 #include <stdint.h> 45 #include <stdbool.h> 46 #include <semaphore.h> 47 #include "fs/fs.h" 48 #include "disk.h" 49 #include "user_copy.h" 50 51 /**************************************************************************** 52 * Pre-processor Definitions 53 ****************************************************************************/ 54 55 #define bchlib_semgive(d) (void)sem_post(&(d)->sem) /* To match bchlib_semtake */ 56 #define MAX_OPENCNT (255) /* Limit of uint8_t */ 57 #define DIOC_GETPRIV (0x1000) 58 59 /**************************************************************************** 60 * Public Types 61 ****************************************************************************/ 62 63 struct bchlib_s 64 { 65 struct Vnode *vnode; /* I-node of the block driver */ 66 uint32_t sectsize; /* The size of one sector on the device */ 67 unsigned long long nsectors; /* Number of sectors supported by the device */ 68 unsigned long long sector; /* The current sector in the buffer */ 69 sem_t sem; /* For atomic accesses to this structure */ 70 uint8_t refs; /* Number of references */ 71 bool dirty; /* true: Data has been written to the buffer */ 72 bool readonly; /* true: Only read operations are supported */ 73 bool unlinked; /* true: The driver has been unlinked */ 74 uint8_t *buffer; /* One sector buffer */ 75 los_disk *disk; 76 unsigned long long sectstart; 77 }; 78 79 /**************************************************************************** 80 * Public Data 81 ****************************************************************************/ 82 83 #undef EXTERN 84 #if defined(__cplusplus) 85 #define EXTERN extern "C" 86 extern "C" { 87 #else 88 #define EXTERN extern 89 #endif 90 91 EXTERN const struct file_operations_vfs bch_fops; 92 93 /**************************************************************************** 94 * Public Function Prototypes 95 ****************************************************************************/ 96 97 EXTERN void bchlib_semtake(struct bchlib_s *bch); 98 EXTERN int bchlib_flushsector(struct bchlib_s *bch); 99 EXTERN int bchlib_readsector(struct bchlib_s *bch, unsigned long long sector); 100 EXTERN int bchlib_setup(const char *blkdev, bool readonly, void **handle); 101 EXTERN int bchlib_teardown(void *handle); 102 EXTERN ssize_t bchlib_read(void *handle, char *buffer, loff_t offset, size_t len); 103 EXTERN ssize_t bchlib_write(void *handle, const char *buffer, loff_t offset, size_t len); 104 105 #undef EXTERN 106 #if defined(__cplusplus) 107 } 108 #endif 109 110 #endif /* __DRIVERS_BCH_BCH_H */ 111