include/storage-expand.h

   1 /*
   2  * storage
   3  * Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the License);
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18
  19 #ifndef __STORAGE_EXPAND_H__
  20 #define __STORAGE_EXPAND_H__
  21
  22 #ifdef __cplusplus
  23 extern "C" {
  24 #endif
  25
  26
  27  /**
  28  * @addtogroup CAPI_SYSTEM_STORAGE_MODULE
  29  * @{
  30  */
  31
  32 #include <tizen.h>
  33
  34
  35 /**
  36  * @brief Enumeration for Storage of error codes.
  37  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  38  */
  39 typedef enum {
  40         STORAGE_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
  41         STORAGE_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
  42         STORAGE_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
  43         STORAGE_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NO_SUCH_DEVICE, /**< Storage not supported */
  44         STORAGE_ERROR_OPERATION_FAILED  = TIZEN_ERROR_SYSTEM_CLASS | 0x12, /**< Operation failed */
  45 } storage_error_e;
  46
  47
  48 /**
  49  * @brief Enumeration for the storage types.
  50  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  51  */
  52 typedef enum {
  53         STORAGE_TYPE_INTERNAL,          /**< Internal device storage (built-in storage in a device, non-removable) */
  54         STORAGE_TYPE_EXTERNAL,          /**< External storage */
  55         STORAGE_TYPE_EXTENDED_INTERNAL, /**< Extended internal storage (External storage used as internal storage) (Since 4.0) */
  56 } storage_type_e;
  57
  58
  59 /**
  60  * @brief Enumeration for storage devices state.
  61  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  62  */
  63 typedef enum {
  64         STORAGE_STATE_UNMOUNTABLE = -2, /**< Storage is present but cannot be mounted. Typically it happens if the file system of the storage is corrupted */
  65         STORAGE_STATE_REMOVED = -1, /**< Storage is not present */
  66         STORAGE_STATE_MOUNTED = 0, /**< Storage is present and mounted with read/write access */
  67         STORAGE_STATE_MOUNTED_READ_ONLY = 1, /**< Storage is present and mounted with read only access */
  68 } storage_state_e;
  69
  70
  71 /**
  72  * @brief Called to get information once for each supported storage.
  73  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  74  * @param[in] storage_id The unique storage ID
  75  * @param[in] type The type of the storage
  76  * @param[in] state The current state of the storage
  77  * @param[in] path The absolute path to the root directory of the storage
  78  * @param[in] user_data The user data passed from the foreach function
  79  * @return @c true to continue with the next iteration of the loop, \n
  80  *         otherwise @c false to break out of the loop
  81  * @pre storage_foreach_device_supported() will invoke this callback function.
  82  * @see storage_foreach_device_supported()
  83  */
  84 typedef bool (*storage_device_supported_cb)(int storage_id, storage_type_e type,
  85                 storage_state_e state, const char *path, void *user_data);
  86
  87
  88 /**
  89  * @brief Retrieves all the storage in a device.
  90  * @details This function invokes the callback function once for each storage in a device. \n
  91  *          If storage_device_supported_cb() returns @c false, then the iteration will be finished.
  92  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  93  * @param[in] callback The iteration callback function
  94  * @param[in] user_data The user data to be passed to the callback function
  95  * @return @c 0 on success,
  96  *         otherwise a negative error value
  97  * @retval #STORAGE_ERROR_NONE Successful
  98  * @retval #STORAGE_ERROR_INVALID_PARAMETER Invalid parameter
  99  * @post This function invokes storage_device_supported_cb() repeatedly for each supported device.
 100  * @see storage_device_supported_cb()
 101  */
 102 int storage_foreach_device_supported(storage_device_supported_cb callback, void *user_data);
 103
 104
 105 /**
 106  * @brief Gets the absolute path to the root directory of the given storage.
 107  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 108  * @remarks Files saved on the internal/external storage are readable or writable by all applications.\n
 109  *          When an application is uninstalled, the files written by that application are not removed from the internal/external storage.\n
 110  *          If you want to access files or directories in internal storage, you must declare http://tizen.org/privilege/mediastorage.\n
 111  *          If you want to access files or directories in external storage, you must declare http://tizen.org/privilege/externalstorage.\n
 112  *          Refer to <a href="https://docs.tizen.org/application/native/guides/security/privacy-related-permissions"><b>Privacy-related Permissions</b></a>.\n
 113  *          You must release @a path using free().
 114  * @param[in] storage_id The storage device
 115  * @param[out] path The absolute path to the storage directory
 116  * @return @c 0 on success,
 117  *         otherwise a negative error value
 118  * @retval #STORAGE_ERROR_NONE Successful
 119  * @retval #STORAGE_ERROR_INVALID_PARAMETER Invalid parameter
 120  * @retval #STORAGE_ERROR_OUT_OF_MEMORY Out of memory
 121  * @retval #STORAGE_ERROR_NOT_SUPPORTED Storage not supported
 122  * @see storage_get_state()
 123  */
 124 int storage_get_root_directory(int storage_id, char **path);
 125
 126
 127 /**
 128  * @brief Enumeration for the storage directory types.
 129  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 130  */
 131 typedef enum {
 132         STORAGE_DIRECTORY_IMAGES, /**< Image directory */
 133         STORAGE_DIRECTORY_SOUNDS, /**< Sounds directory */
 134         STORAGE_DIRECTORY_VIDEOS, /**< Videos directory */
 135         STORAGE_DIRECTORY_CAMERA, /**< Camera directory */
 136         STORAGE_DIRECTORY_DOWNLOADS, /**< Downloads directory */
 137         STORAGE_DIRECTORY_MUSIC, /**< Music directory */
 138         STORAGE_DIRECTORY_DOCUMENTS, /**< Documents directory */
 139         STORAGE_DIRECTORY_OTHERS, /**< Others directory */
 140         STORAGE_DIRECTORY_SYSTEM_RINGTONES, /**< System ringtones directory. Only available for internal storage. */
 141         STORAGE_DIRECTORY_MAX
 142 } storage_directory_e;
 143
 144
 145 /**
 146  * @brief Gets the absolute path to the each directory of the given storage.
 147  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 148  * @remarks Files saved on the internal/external storage are readable or writable by all applications.\n
 149  *          When an application is uninstalled, the files written by that application are not removed from the internal/external storage.\n
 150  *          The directory path may not exist, so you must make sure that it exists before using it.\n
 151  *          If you want to access files or directories in internal storage, you must declare http://tizen.org/privilege/mediastorage.\n
 152  *          If you want to access files or directories in external storage, you must declare http://tizen.org/privilege/externalstorage.\n
 153  *          Refer to <a href="https://docs.tizen.org/application/native/guides/security/privacy-related-permissions"><b>Privacy-related Permissions</b></a>.\n
 154  *          You must release @a path using free().
 155  * @param[in] storage_id The storage device
 156  * @param[in] type The directory type
 157  * @param[out] path The absolute path to the directory type
 158  * @return @c 0 on success,
 159  *         otherwise a negative error value
 160  * @retval #STORAGE_ERROR_NONE Successful
 161  * @retval #STORAGE_ERROR_INVALID_PARAMETER Invalid parameter
 162  * @retval #STORAGE_ERROR_OUT_OF_MEMORY Out of memory
 163  * @retval #STORAGE_ERROR_NOT_SUPPORTED Storage not supported
 164  * @see storage_get_state()
 165  */
 166 int storage_get_directory(int storage_id, storage_directory_e type, char **path);
 167
 168
 169 /**
 170  * @brief Gets the type of the given storage.
 171  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 172  * @param[in] storage_id The storage device
 173  * @param[out] type The type of the storage
 174  * @return @c 0 on success,
 175  *         otherwise a negative error value
 176  * @retval #STORAGE_ERROR_NONE Successful
 177  * @retval #STORAGE_ERROR_INVALID_PARAMETER Invalid parameter
 178  * @retval #STORAGE_ERROR_NOT_SUPPORTED Storage not supported
 179  */
 180 int storage_get_type(int storage_id, storage_type_e *type);
 181
 182
 183 /**
 184  * @brief Gets the current state of the given storage.
 185  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 186  * @param[in] storage_id The storage device
 187  * @param[out] state The current state of the storage
 188  * @return @c 0 on success,
 189  *         otherwise a negative error value
 190  * @retval #STORAGE_ERROR_NONE Successful
 191  * @retval #STORAGE_ERROR_INVALID_PARAMETER Invalid parameter
 192  * @retval #STORAGE_ERROR_NOT_SUPPORTED Storage not supported
 193  * @see storage_get_root_directory()
 194  * @see storage_get_total_space()
 195  * @see storage_get_available_space()
 196  */
 197 int storage_get_state(int storage_id, storage_state_e *state);
 198
 199
 200 /**
 201  * @brief Called when the state of storage changes.
 202  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 203  * @param[in] storage_id The unique storage ID
 204  * @param[in] state The current state of the storage
 205  * @param[in] user_data The user data passed from the foreach function
 206  * @pre storage_set_state_changed_cb() will invoke this callback function.
 207  * @see storage_set_state_changed_cb()
 208  * @see storage_unset_state_changed_cb()
 209  */
 210 typedef void (*storage_state_changed_cb)(int storage_id, storage_state_e state, void *user_data);
 211
 212
 213 /**
 214  * @brief Registers a callback function to be invoked when the state of the storage changes.
 215  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 216  * @param[in] storage_id The storage device
 217  * @param[in] callback The callback function to register
 218  * @param[in] user_data The user data to be passed to the callback function
 219  * @return @c 0 on success,
 220  *         otherwise a negative error value
 221  * @retval #STORAGE_ERROR_NONE Successful
 222  * @retval #STORAGE_ERROR_INVALID_PARAMETER Invalid parameter
 223  * @retval #STORAGE_ERROR_NOT_SUPPORTED Storage not supported
 224  * @retval #STORAGE_ERROR_OPERATION_FAILED Operation failed
 225  * @post storage_state_changed_cb() will be invoked if the state of the registered storage changes.
 226  * @see storage_state_changed_cb()
 227  * @see storage_unset_state_changed_cb()
 228  */
 229 int storage_set_state_changed_cb(int storage_id, storage_state_changed_cb callback, void *user_data);
 230
 231
 232 /**
 233  * @brief Unregisters the callback function.
 234  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 235  * @param[in] storage_id The storage device to monitor
 236  * @param[in] callback The callback function to register
 237  * @return @c 0 on success,
 238  *         otherwise a negative error value
 239  * @retval #STORAGE_ERROR_NONE Successful
 240  * @retval #STORAGE_ERROR_INVALID_PARAMETER Invalid parameter
 241  * @retval #STORAGE_ERROR_NOT_SUPPORTED Storage not supported
 242  * @retval #STORAGE_ERROR_OPERATION_FAILED Operation failed
 243  * @see storage_state_changed_cb()
 244  * @see storage_set_state_changed_cb()
 245  */
 246 int storage_unset_state_changed_cb(int storage_id, storage_state_changed_cb callback);
 247
 248
 249 /**
 250  * @brief Enumeration for storage device types.
 251  * @since_tizen 3.0
 252  */
 253 typedef enum {
 254         STORAGE_DEV_EXT_SDCARD = 1001,     /**< SD card device (external storage) */
 255         STORAGE_DEV_EXT_USB_MASS_STORAGE,  /**< USB storage device (external storage) */
 256         STORAGE_DEV_EXTENDED_INTERNAL,     /**< Extended internal storage device (External storage used as internal storage) (Since 4.0) */
 257 } storage_dev_e;
 258
 259
 260 /**
 261  * @brief Called when the state of a storage type changes.
 262  * @since_tizen 3.0
 263  * @param[in] storage_id The unique storage ID
 264  * @param[in] dev The type of the external storage device
 265  * @param[in] state The state of the storage
 266  * @param[in] fstype The type of the file system
 267  * @param[in] fsuuid The uuid of the file system
 268  * @param[in] mountpath The mount path of the file system
 269  * @param[in] primary The primary partition
 270  * @param[in] flags The flags for the storage status
 271  * @param[in] user_data The user data
 272  * @pre storage_set_changed_cb() will invoke this callback function.
 273  * @see storage_set_changed_cb()
 274  * @see storage_unset_changed_cb()
 275  */
 276 typedef void (*storage_changed_cb)(int storage_id,
 277                 storage_dev_e dev, storage_state_e state,
 278                 const char *fstype, const char *fsuuid, const char *mountpath,
 279                 bool primary, int flags, void *user_data);
 280
 281
 282 /**
 283  * @brief Registers a callback function to be invoked when the state of the specified storage device type changes.
 284  * @since_tizen 3.0
 285  * @param[in] type The type of the storage device
 286  * @param[in] callback The callback function to register
 287  * @param[in] user_data The user data to be passed to the callback function
 288  * @return @c 0 on success,
 289  *         otherwise a negative error value
 290  * @retval #STORAGE_ERROR_NONE Successful
 291  * @retval #STORAGE_ERROR_INVALID_PARAMETER Invalid parameter
 292  * @retval #STORAGE_ERROR_NOT_SUPPORTED Storage not supported
 293  * @retval #STORAGE_ERROR_OPERATION_FAILED Operation failed
 294  * @post storage_changed_cb() will be invoked if the state of the registered storage type changes.
 295  * @see storage_changed_cb()
 296  * @see storage_unset_changed_cb()
 297  */
 298 int storage_set_changed_cb(storage_type_e type, storage_changed_cb callback, void *user_data);
 299
 300
 301 /**
 302  * @brief Unregisters the callback function for storage type state changes.
 303  * @since_tizen 3.0
 304  * @param[in] type The type of the the storage device
 305  * @param[in] callback The callback function to unregister
 306  * @return @c 0 on success,
 307  *         otherwise a negative error value
 308  * @retval #STORAGE_ERROR_NONE Successful
 309  * @retval #STORAGE_ERROR_INVALID_PARAMETER Invalid parameter
 310  * @retval #STORAGE_ERROR_NOT_SUPPORTED Storage not supported
 311  * @retval #STORAGE_ERROR_OPERATION_FAILED Operation failed
 312  * @see storage_changed_cb()
 313  * @see storage_set_changed_cb()
 314  */
 315 int storage_unset_changed_cb(storage_type_e type, storage_changed_cb callback);
 316
 317
 318 /**
 319  * @brief Gets the total space of the given storage in bytes.
 320  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 321  * @param[in] storage_id The storage device
 322  * @param[out] bytes The total space size of the storage (bytes)
 323  * @return @c 0 on success,
 324  *         otherwise a negative error value
 325  * @retval #STORAGE_ERROR_NONE Successful
 326  * @retval #STORAGE_ERROR_INVALID_PARAMETER Invalid parameter
 327  * @retval #STORAGE_ERROR_NOT_SUPPORTED Storage not supported
 328  * @retval #STORAGE_ERROR_OPERATION_FAILED Operation failed
 329  * @see storage_get_state()
 330  * @see storage_get_available_space()
 331  */
 332 int storage_get_total_space(int storage_id, unsigned long long *bytes);
 333
 334
 335 /**
 336  * @brief Gets the available space size of the given storage in bytes.
 337  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 338  * @param[in] storage_id The storage device
 339  * @param[out] bytes The available space size of the storage (bytes)
 340  * @return @c 0 on success,
 341  *         otherwise a negative error value
 342  * @retval #STORAGE_ERROR_NONE Successful
 343  * @retval #STORAGE_ERROR_INVALID_PARAMETER Invalid parameter
 344  * @retval #STORAGE_ERROR_NOT_SUPPORTED Storage not supported
 345  * @retval #STORAGE_ERROR_OPERATION_FAILED Operation failed
 346  * @see storage_get_state()
 347  * @see storage_get_total_space()
 348  */
 349 int storage_get_available_space(int storage_id, unsigned long long *bytes);
 350
 351
 352 /**
 353  * @}
 354  */
 355
 356 #ifdef __cplusplus
 357 }
 358 #endif
 359 #endif