nvram_device स्ट्रक्चर का रेफ़रंस

nvram_device स्ट्रक्चर का रेफ़रंस

#include < nvram.h >

डेटा फ़ील्ड

struct hw_device_t   सामान्य
 
nvram_result_t (*  get_total_size_in_bytes )(const struct nvram_device *device, uint64_t *total_size)
 
nvram_result_t (*  get_available_size_in_bytes )(const struct nvram_device *device, uint64_t *available_size)
 
nvram_result_t (*  get_max_space_size_in_bytes )(const struct nvram_device *device, uint64_t *max_space_size)
 
nvram_result_t (*  get_max_spaces )(const struct nvram_device *device, uint32_t *num_spaces)
 
nvram_result_t (*  get_space_list )(const struct nvram_device *device, uint32_t max_list_size, uint32_t *space_index_list, uint32_t *list_size)
 
nvram_result_t (*  get_space_size )(const struct nvram_device *device, uint32_t index, uint64_t *size)
 
nvram_result_t (*  get_space_controls )(const struct nvram_device *device, uint32_t index, uint32_t max_list_size, nvram_control_t *control_list, uint32_t *list_size)
 
nvram_result_t (*  is_space_locked )(const struct nvram_device *device, uint32_t index, int *write_lock_enabled, int *read_lock_enabled)
 
nvram_result_t (*  create_space )(const struct nvram_device *device, uint32_t index, uint64_t size_in_bytes, const nvram_control_t *control_list, uint32_t list_size, const uint8_t *authorization_value, uint32_t authorization_value_size)
 
nvram_result_t (*  delete_space )(const struct nvram_device *device, uint32_t index, const uint8_t *authorization_value, uint32_t authorization_value_size)
 
nvram_result_t (*  disable_create )(const struct nvram_device *device)
 
nvram_result_t (*  write_space )(const struct nvram_device *device, uint32_t index, const uint8_t *buffer, uint64_t buffer_size, const uint8_t *authorization_value, uint32_t authorization_value_size)
 
nvram_result_t (*  read_space )(const struct nvram_device *device, uint32_t index, uint64_t num_bytes_to_read, const uint8_t *authorization_value, uint32_t authorization_value_size, uint8_t *buffer, uint64_t *bytes_read)
 
nvram_result_t (*  enable_write_lock )(const struct nvram_device *device, uint32_t index, const uint8_t *authorization_value, uint32_t authorization_value_size)
 
nvram_result_t (*  enable_read_lock )(const struct nvram_device *device, uint32_t index, const uint8_t *authorization_value, uint32_t authorization_value_size)
 

पूरी जानकारी

nvram.h फ़ाइल की लाइन 48 पर परिभाषा.

फ़ील्ड का दस्तावेज़

struct hw_device_t common

nvram_device के सामान्य तरीके . यह nvram_device के पहले सदस्य के तौर पर होना चाहिए, क्योंकि इस स्ट्रक्चर के उपयोगकर्ता, hw_device_t को nvram_device के पॉइंटर पर डालेंगे. ऐसा उन संदर्भों में किया जाएगा जहां यह पता हो कि hw_device_t किसी nvram_device का रेफ़रंस देता है .

परिभाषा, nvram.h फ़ाइल की लाइन 55 पर दी गई है.

nvram_result_t (* create_space)(const struct nvram_device *device, uint32_t index, uint64_t size_in_bytes, const nvram_control_t *control_list, uint32_t list_size, const uint8_t *authorization_value, uint32_t authorization_value_size)

दिए गए इंडेक्स, साइज़, कंट्रोल, और अनुमति की वैल्यू के साथ नया स्पेस बनाता है.

device - nvram_device के उदाहरण. index - नए स्पेस का इंडेक्स. इंडेक्स, 32-बिट की कोई भी वैल्यू हो सकती है. हालांकि, यह किसी मौजूदा स्पेस को पहले से असाइन नहीं किया जाना चाहिए. size_in_bytes - स्पेस के लिए, बाइट का वह साइज़ जो तय करना है. control_list - स्पेस के लिए लागू किए जाने वाले कंट्रोल का कलेक्शन. list_size - |control_list| में मौजूद आइटम की संख्या. authorization_value - अगर |control_list| में NV_CONTROL_READ_AUTHORIZATION और / या NV_CONTROL_WRITE_AUTHORIZATION शामिल है, तो यह पैरामीटर इन नीतियों के लिए अनुमति की वैल्यू देता है. अगर दोनों कंट्रोल सेट हैं, तो यह वैल्यू दोनों पर लागू होती है. अगर ऐसा नहीं है, तो इस वैल्यू को अनदेखा कर दिया जाता है और यह शून्य हो सकती है. authorization_value_size - |authorization_value| में बाइट की संख्या.

परिभाषा, nvram.h फ़ाइल की लाइन 187 पर दी गई है.

nvram_result_t (* delete_space)(const struct nvram_device *device, uint32_t index, const uint8_t *authorization_value, uint32_t authorization_value_size)

स्पेस को मिटाता है.

device - nvram_device के इंस्टेंस की जानकारी. index - स्पेस का इंडेक्स. authorization_value - अगर स्पेस में NV_CONTROL_WRITE_AUTHORIZATION नीति लागू है, तो यह पैरामीटर अनुमति की वैल्यू देता है. अगर ऐसा नहीं है, तो इस वैल्यू को अनदेखा कर दिया जाता है और यह शून्य हो सकती है. authorization_value_size - |authorization_value| में बाइट की संख्या.

परिभाषा, nvram.h फ़ाइल की लाइन 207 पर दी गई है .

nvram_result_t (* disable_create)(const struct nvram_device *device)

डिवाइस को अगली बार पूरी तरह से रीसेट करने (फ़ैक्ट्री रीसेट, न कि रीबूट) तक, स्पेस बनाने की सुविधा बंद कर देता है. NV_CreateSpace के बाद के कॉल में, NV_RESULT_OPERATION_DISABLED दिखना चाहिए.

device - nvram_device के उदाहरण.

परिभाषा, nvram.h फ़ाइल की लाइन 219 पर दी गई है.

nvram_result_t (* enable_read_lock)(const struct nvram_device *device, uint32_t index, const uint8_t *authorization_value, uint32_t authorization_value_size)

स्पेस की नीति के मुताबिक, उसमें मौजूद कॉन्टेंट को पढ़ने पर लॉक लगाता है. अगर स्पेस में NV_CONTROL_BOOT_READ_LOCK सेट नहीं है, तो इस फ़ंक्शन का कोई असर नहीं पड़ेगा और गड़बड़ी का मैसेज दिख सकता है.

device - nvram_device के इंस्टेंस की वैल्यू. index - स्पेस का इंडेक्स. authorization_value - अगर स्पेस में NV_CONTROL_READ_AUTHORIZATION नीति है, तो यह पैरामीटर अनुमति की वैल्यू देता है. ध्यान दें कि पढ़ने के लिए लॉक करने के लिए, लिखने का ऐक्सेस होना ज़रूरी नहीं है. रीड लॉक हमेशा अस्थिर होता है.) अगर ऐसा नहीं है, तो इस वैल्यू को अनदेखा कर दिया जाता है और यह शून्य हो सकती है. authorization_value_size - |authorization_value| में बाइट की संख्या.

परिभाषा, nvram.h फ़ाइल की लाइन 317 पर दी गई है.

nvram_result_t (* enable_write_lock)(const struct nvram_device *device, uint32_t index, const uint8_t *authorization_value, uint32_t authorization_value_size)

स्पेस की नीति के मुताबिक, उसमें बदलाव करने पर रोक लगाता है. अगर स्पेस में NV_CONTROL_PERSISTENT_WRITE_LOCK या NV_CONTROL_BOOT_WRITE_LOCK सेट नहीं है, तो इस फ़ंक्शन का कोई असर नहीं होगा और हो सकता है कि यह गड़बड़ी दिखाए.

device - nvram_device के इंस्टेंस की जानकारी. index - स्पेस का इंडेक्स. authorization_value - अगर स्पेस में NV_CONTROL_WRITE_AUTHORIZATION नीति लागू है, तो यह पैरामीटर अनुमति की वैल्यू देता है. अगर ऐसा नहीं है, तो इस वैल्यू को अनदेखा कर दिया जाता है और यह शून्य हो सकती है. authorization_value_size - |authorization_value| में बाइट की संख्या.

परिभाषा, nvram.h फ़ाइल की लाइन 294 पर दी गई है.

nvram_result_t (* get_available_size_in_bytes)(const struct nvram_device *device, uint64_t *available_size)

NVRAM में उपलब्ध बाइट की संख्या दिखाता है. अगर किसी लागू करने की प्रोसेस में उपलब्ध साइज़ की जानकारी नहीं है, तो वह अनुमान या कुल साइज़ दे सकती है.

device - nvram_device इंस्टेंस. available_size - आउटपुट पाता है. यह शून्य नहीं हो सकता.

परिभाषा, nvram.h फ़ाइल की लाइन 76 पर दी गई है.

nvram_result_t (* get_max_space_size_in_bytes)(const struct nvram_device *device, uint64_t *max_space_size)

एक स्पेस के लिए, ज़्यादा से ज़्यादा कितने बाइट असाइन किए जा सकते हैं, यह दिखाता है. यह हमेशा कम से कम 32 होगा. अगर लागू करने के तरीके में ज़्यादा से ज़्यादा साइज़ की कोई सीमा नहीं है, तो हो सकता है कि वह कुल साइज़ दिखाए.

device - nvram_device इंस्टेंस. max_space_size - आउटपुट पाता है. यह शून्य नहीं हो सकता.

परिभाषा, nvram.h फ़ाइल की लाइन 87 पर दी गई है.

nvram_result_t (* get_max_spaces)(const struct nvram_device *device, uint32_t *num_spaces)

यह फ़ंक्शन, असाइन की जा सकने वाली स्पेस की कुल संख्या दिखाता है. यह हमेशा कम से कम आठ होगा. अगर स्पेस की कोई भी संख्या काम करती है, तो NV_UNLIMITED_SPACES दिखाता है. हालांकि, यह सिर्फ़ उपलब्ध NVRAM बाइट तक सीमित है.

device - nvram_device इंस्टेंस. num_spaces - आउटपुट पाता है. यह शून्य नहीं हो सकता.

nvram.h फ़ाइल की लाइन 99 पर परिभाषा.

nvram_result_t (* get_space_controls)(const struct nvram_device *device, uint32_t index, uint32_t max_list_size, nvram_control_t *control_list, uint32_t *list_size)

किसी स्पेस से जुड़े कंट्रोल की सूची दिखाता है.

device - यह nvram_device इंस्टेंस है. index - यह स्पेस का इंडेक्स है. max_list_size - यह |control_list| कलेक्शन में मौजूद आइटम की संख्या है. control_list - इसमें दिए गए |max_list_size| तक के कंट्रोल की सूची मिलती है. अगर |max_list_size| शून्य है, तो यह शून्य हो सकता है. list_size - इसमें |control_list| में मौजूद आइटम की संख्या मिलती है. अगर |control_list| शून्य है, तो यह उपलब्ध आइटम की संख्या होती है.

परिभाषा, nvram.h फ़ाइल की लाइन 144 पर दी गई है.

nvram_result_t (* get_space_list)(const struct nvram_device *device, uint32_t max_list_size, uint32_t *space_index_list, uint32_t *list_size)

बनाए गए स्पेस इंडेक्स की सूची दिखाता है. अगर |max_list_size| 0 है, तो सिर्फ़ |list_size| की वैल्यू अपने-आप भर जाती है.

device - यह nvram_device इंस्टेंस है. max_list_size - |space_index_list| कलेक्शन में मौजूद आइटम की संख्या. space_index_list - इसमें, दिए गए |max_list_size| तक के बनाए गए स्पेस की सूची मिलती है. अगर |max_list_size| 0 है, तो यह शून्य हो सकती है. list_size - इसमें, |space_index_list| में मौजूद आइटम की संख्या मिलती है. अगर |space_index_list| शून्य है, तो यह उपलब्ध आइटम की संख्या होती है.

परिभाषा, nvram.h फ़ाइल की लाइन 116 पर दी गई है.

nvram_result_t (* get_space_size)(const struct nvram_device *device, uint32_t index, uint64_t *size)

किसी स्पेस का साइज़, बाइट में दिखाता है.

device - nvram_device के उदाहरण. index - स्टोरेज का इंडेक्स. size - आउटपुट पाता है. यह शून्य नहीं हो सकता.

परिभाषा, nvram.h फ़ाइल की लाइन 128 पर दी गई है.

nvram_result_t (* get_total_size_in_bytes)(const struct nvram_device *device, uint64_t *total_size)

NVRAM में उपलब्ध बाइट की कुल संख्या दिखाता है. यह हमेशा कम से कम 2048 होगा. अगर किसी लागू करने की प्रोसेस में कुल साइज़ की जानकारी नहीं है, तो वह अनुमान या 2048 दे सकती है.

device - nvram_device इंस्टेंस. total_size - आउटपुट पाता है. यह शून्य नहीं हो सकता.

परिभाषा, nvram.h फ़ाइल की लाइन 65 पर दी गई है.

nvram_result_t (* is_space_locked)(const struct nvram_device *device, uint32_t index, int *write_lock_enabled, int *read_lock_enabled)

इससे पता चलता है कि दिए गए स्पेस के लिए लॉक चालू हैं या नहीं. लॉक चालू होने पर, कार्रवाई बंद हो जाती है. साथ ही, उस कार्रवाई को करने की कोशिश करने पर, NV_RESULT_OPERATION_DISABLED दिखेगा.

device - nvram_device का उदाहरण. index - स्पेस का इंडेक्स. write_lock_enabled - अगर फ़िलहाल डेटा लिखने की सुविधा बंद है, तो यह वैल्यू शून्य के अलावा किसी और वैल्यू पर सेट होगी. read_lock_enabled - अगर फ़िलहाल डेटा पढ़ने की सुविधा बंद है, तो यह वैल्यू शून्य के अलावा किसी और वैल्यू पर सेट होगी.

परिभाषा, nvram.h फ़ाइल की लाइन 161 पर दी गई है.

nvram_result_t (* read_space)(const struct nvram_device *device, uint32_t index, uint64_t num_bytes_to_read, const uint8_t *authorization_value, uint32_t authorization_value_size, uint8_t *buffer, uint64_t *bytes_read)

किसी स्पेस का कॉन्टेंट पढ़ता है. अगर स्पेस में कभी भी डेटा नहीं डाला गया है, तो पढ़े गए सभी बाइट 0x00 होंगे.

device - nvram_device के उदाहरण. index - स्टोरेज का इंडेक्स. num_bytes_to_read - पढ़े जाने वाले बाइट की संख्या; |buffer| इतना बड़ा होना चाहिए कि उसमें इतने बाइट आ सकें. अगर यह स्पेस के साइज़ से ज़्यादा है, तो पूरा स्पेस पढ़ा जाता है. अगर यह स्पेस के साइज़ से कम है, तो स्पेस के पहले बाइट पढ़े जाते हैं. authorization_value - अगर स्पेस में NV_CONTROL_READ_AUTHORIZATION नीति है, तो यह पैरामीटर अनुमति की वैल्यू देता है. ऐसा न करने पर, इस वैल्यू को अनदेखा कर दिया जाता है और यह शून्य हो सकती है. authorization_value_size - |authorization_value| में बाइट की संख्या. buffer - इसमें स्पेस से पढ़ा गया डेटा मिलता है. इसका साइज़ कम से कम |num_bytes_to_read| बाइट होना चाहिए. bytes_read - पढ़े गए बाइट की संख्या. अगर NV_RESULT_SUCCESS दिखता है, तो इसे |num_bytes_to_read| या स्पेस के साइज़ में से किसी एक पर सेट किया जाएगा.

परिभाषा, nvram.h फ़ाइल की लाइन 272 पर दी गई है.

nvram_result_t (* write_space)(const struct nvram_device *device, uint32_t index, const uint8_t *buffer, uint64_t buffer_size, const uint8_t *authorization_value, uint32_t authorization_value_size)

स्पेस में कॉन्टेंट लिखता है. अगर स्पेस को NV_CONTROL_WRITE_EXTEND के साथ कॉन्फ़िगर किया गया है, तो मौजूदा डेटा को बढ़ाने के लिए इनपुट डेटा का इस्तेमाल किया जाता है.

device - nvram_device के उदाहरण. index - स्टोरेज का इंडेक्स. buffer - लिखा जाने वाला डेटा. buffer_size - |buffer| में मौजूद बाइट की संख्या. अगर यह स्टोरेज के साइज़ से कम है, तो बाकी बाइट 0x00 पर सेट हो जाएंगे. अगर यह स्पेस के साइज़ से ज़्यादा है, तो NV_RESULT_INVALID_PARAMETER दिखाता है. authorization_value - अगर स्पेस में NV_CONTROL_WRITE_AUTHORIZATION नीति लागू है, तो यह पैरामीटर अनुमति की वैल्यू दिखाता है. अगर ऐसा नहीं है, तो इस वैल्यू को अनदेखा कर दिया जाता है और यह शून्य हो सकती है. authorization_value_size - |authorization_value| में बाइट की संख्या.

परिभाषा, nvram.h फ़ाइल की लाइन 241 पर दी गई है.


इस स्ट्रक्चर का दस्तावेज़, इस फ़ाइल से जनरेट किया गया था:
  • hardware/libhardware/include/hardware/ nvram.h