From mboxrd@z Thu Jan 1 00:00:00 1970 From: George Dunlap Subject: [PATCH v2 8/9] docs: Document block-script protocol Date: Mon, 21 Mar 2016 18:17:00 +0000 Message-ID: <1458584221-24426-9-git-send-email-george.dunlap@citrix.com> References: <1458584221-24426-1-git-send-email-george.dunlap@citrix.com> Mime-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: base64 Return-path: In-Reply-To: <1458584221-24426-1-git-send-email-george.dunlap@citrix.com> List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xen.org Sender: "Xen-devel" To: xen-devel@lists.xen.org Cc: Ian Jackson , Wei Liu , George Dunlap , Roger Pau Monne List-Id: xen-devel@lists.xenproject.org U2lnbmVkLW9mZi1ieTogR2VvcmdlIER1bmxhcCA8Z2VvcmdlLmR1bmxhcEBjaXRyaXguY29tPgot LS0KQ2hhbmdlcyBzaW5jZSB2MToKLSBBdHRlbXB0IHRvIG1ha2UgYSBjbGVhciBkaXN0aW5jdGlv biBiZXR3ZWVuIGN1c3RvbSBob3RwbHVnIHNjcmlwdHMKYW5kIHRoZSBzY3JpcHQgY2FsbGVkIGZv ciByYXcgcGh5c2ljYWwgZGV2aWNlcyBhbmQgZmlsZXMKCkNDOiBJYW4gSmFja3NvbiA8aWFuLmph Y2tzb25AY2l0cml4LmNvbT4KQ0M6IFdlaSBMaXUgPHdlaS5saXUyQGNpdHJpeC5jb20+CkNDOiBS b2dlciBQYXUgTW9ubmUgPHJvZ2VyLnBhdUBjaXRyaXguY29tPgotLS0KIGRvY3MvbWlzYy9ibG9j ay1zY3JpcHRzLnR4dCB8IDEwMSArKysrKysrKysrKysrKysrKysrKysrKysrKysrKysrKysrKysr KysrKysrKwogMSBmaWxlIGNoYW5nZWQsIDEwMSBpbnNlcnRpb25zKCspCgpkaWZmIC0tZ2l0IGEv ZG9jcy9taXNjL2Jsb2NrLXNjcmlwdHMudHh0IGIvZG9jcy9taXNjL2Jsb2NrLXNjcmlwdHMudHh0 Cm5ldyBmaWxlIG1vZGUgMTAwNjQ0CmluZGV4IDAwMDAwMDAuLjZkZDVkNDgKLS0tIC9kZXYvbnVs bAorKysgYi9kb2NzL21pc2MvYmxvY2stc2NyaXB0cy50eHQKQEAgLTAsMCArMSwxMDEgQEAKK0Js b2NrIHNjcmlwdHMKKz09PT09PT09PT09PT0KKworQmxvY2sgc2NyaXB0cyBhcmUgY2FsbGVkIGF0 IHRoZSBtb21lbnQgYW55dGltZSBibGtiYWNrIGlzIGRpcmVjdGx5CitpbnZvbHZlZCBpbiBwcm92 aWRpbmcgYWNjZXNzIHRvIGEgYmFja2VuZC4gIFRoZXJlIGFyZSB0aHJlZSBnZW5lcmFsCitjYXNl cyB0aGlzIGhhcHBlbnM6CisKKzEuIFdoZW4gYSB1c2VyIHBhc3NlcyBhIGJsb2NrIGRldmljZSBp biB0aGUgJ3RhcmdldCcgZmllbGQgb2YgdGhlIGRpc2sKK3NwZWNpZmljYXRpb24KKworMi4gV2hl biBhIHVzZXIgcGFzc2VzIGEgZmlsZSBpbiB0aGUgJ3RhcmdldCcgZmllbGQgb2YgdGhlIGRpc2sK K3NwZWNpZmljYXRpb24KKworMy4gV2hlbiBhIHVzZXIgc3BlY2lmaWVzIGEgY3VzdG9tIGhvdHBs dWcgc2NyaXB0LgorCitTZXR1cAorLS0tLS0KKworSXQgaXMgaGlnaGx5IHJlY29tbWVuZGVkIHRo YXQgY3VzdG9tIGhvdHBsdWcgc2NyaXB0cyBhcyBtdWNoIGFzCitwb3NzaWJsZSBpbmNsdWRlIGFu ZCB1c2UgdGhlIGNvbW1vbiBYZW4gZnVuY3Rpb25hbGl0eS4gIElmIHRoZSBzY3JpcHQKK2lzIHJ1 biBmcm9tIHRoZSBub3JtYWwgYmxvY2sgc2NyaXB0IGxvY2F0aW9uICgvZXRjL3hlbi9zY3JpcHRz IGJ5CitkZWZhdWx0KSwgdGhlbiB0aGlzIGNhbiBiZSBkb25lIGJ5IGFkZGluZyB0aGUgZm9sbG93 aW5nIHRvIHRoZSB0b3Agb2YKK3RoZSBzY3JpcHQ6CisKK2Rpcj0kKGRpcm5hbWUgIiQwIikKKy4g IiRkaXIvYmxvY2stY29tbW9uLnNoIgorCisKK0lucHV0cworLS0tLS0tCisKK0luIGFsbCBjYXNl cywgdGhlIHNjcmlwdHMgYXJlIGNhbGxlZCB3aXRoIGVpdGhlciAiYWRkIiBvciAicmVtb3ZlIiBh cwordGhlIGNvbW1hbmQuICBGb3IgY3VzdG9tIHNjcmlwdHMsIHRoZSBjb21tYW5kIHdpbGwgYmUg dGhlIGZpcnN0Cithcmd1bWVudCBvZiB0aGUgc2NyaXB0IChpLmUuICQxKS4KKworVGhlIGVudmly b25tZW50IHZhcmlhYmxlIFhFTkJVU19QQVRIIHdpbGwgYmUgc2V0IHRvIHRoZQorcGF0aCBmb3Ig dGhlIGJsb2NrIGRldmljZSB0byBiZSBjcmVhdGVkLgorCitXaGVuIHRoZSBzY3JpcHQgaXMgcnVu LCB0aGUgZm9sbG93aW5nIG5vZGVzIHNoYWxsIGFscmVhZHkgaGF2ZSBiZWVuCit3cml0dGVuIGlu dG8geGVuc3RvcmU6CisKKyAkWEVOQlVTL3BhcmFtcyAgICBUaGUgY29udGVudHMgb2YgdGhlICd0 YXJnZXQnIHNlY3Rpb24gb2YgdGhlIGRpc2sgc3BlY2lmaWNhdGlvbiB2ZXJiYXRpbS4KKyAkWEVO QlVTL21vZGUgICAgICAncicgKGZvciByZWFkb25seSkgb3IgJ3cnIChmb3IgcmVhZC13cml0ZSkK KworT3V0cHV0CistLS0tLS0tCisKK0Jsb2NrIHNjcmlwdHMgYXJlIHJlc3BvbnNpYmxlIGZvciBt YWtpbmcgc3VyZSB0aGF0IGlmIGEgZmlsZSBpcworcHJvdmlkZWQgdG8gYSBWTSByZWFkL3dyaXRl LCB0aGF0IGl0IGlzIG5vdCBwcm92aWRlZCB0byBhbnkgb3RoZXIgVk0uCisKK0ZyZWVCU0QgYmxv Y2sgaG90cGx1ZyBzY3JpcHRzIG11c3Qgd3JpdGUKKyIkWEVOQlVTX1BBVEgvcGh5c2ljYWwtZGV2 aWNlLXBhdGgiIHdpdGggdGhlIHBhdGggdG8gdGhlIHBoeXNpY2FsCitkZXZpY2Ugb3IgZmlsZS4g IExpbnV4IGFuZCBOZXRCU0QgYmxvY2sgaG90cGx1ZyBzY3JpcHRzICpzaG91bGQqIGFsc28KK3dy aXRlIHRoaXMgbm9kZS4KKworRm9yIHRoZSB0aW1lIGJlaW5nLCBMaW51eCBhbmQgTmV0QlNEIGJs b2NrIGhvdHBsdWcgc2NyaXB0cyBtdXN0IHdyaXRlCisiJFhFTkJVU19QQVRIL3BoeXNpY2FsLWRl dmljZSIgd2l0aCB0aGUgZGV2aWNlJ3MgbWFqb3IgYW5kIG1pbm9yCitudW1iZXJzLCB3cml0dGVu IGluIGhleCwgYW5kIHNlcGFyYXRlZCBieSBhIGNvbG9uLgorCitTY3JpcHRzIHdoaWNoIGluY2x1 ZGUgYmxvY2stY29tbW9uLnNoIGNhbiBzaW1wbHkgY2FsbCB3cml0ZV9kZXYgIiRkZXYiCit3aXRo IGEgcGF0aCB0byB0aGUgZGV2aWNlLCBhbmQgd3JpdGVfZGV2IHdpbGwgZG8gdGhlIHJpZ2h0IHRo aW5nLCBub3cKK2FuZCBnb2luZyBmb3J3YXJkLiAgKFNlZSB0aGUgZGlzY3Vzc2lvbiBiZWxvdy4p CisKK1JhdGlvbmFsZSBhbmQgZnV0dXJlIHdvcmsKKy0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0K KworSGlzdG9yaWNhbGx5LCB0aGUgYmxvY2sgc2NyaXB0cyB3cm90ZSBhIG5vZGUgY2FsbGVkICJw aHlzaWNhbC1kZXZpY2UiLAord2hpY2ggY29udGFpbnMgdGhlIG1ham9yIGFuZCBtaW5vciBudW1i ZXJzLCB3cml0dGVuIGluIGhleCwgYW5kCitzZXBhcmF0ZWQgYnkgYSBjb2xvbiAoZS5nLiwgIjFh OjIiKS4gIFRoaXMgaXMgcmVxdWlyZWQgYnkgdGhlIExpbnV4CitibGtiYWNrIGRyaXZlci4KKwor RnJlZUJTRCBibGtiYWNrLCBvbiB0aGUgb3RoZXIgaGFuZCwgZG9lcyBub3QgaGF2ZSB0aGUgY29u Y2VwdCBvZgorbWFqb3IvbWlub3IgbnVtYmVycywgYW5kIGNhbiBnaXZlIGRpcmVjdCBhY2Nlc3Mg dG8gYSBmaWxlIHdpdGhvdXQKK2dvaW5nIHRocm91Z2ggbG9vcGJhY2s7IHNvIGl0cyBkcml2ZXIg d2lsbCBjb25zdW1lCitwaHlzaWNhbC1kZXZpY2UtcGF0aC4KKworT24gTGludXgsIHRoZSBkZXZp Y2UgbW9kZWwgKHFlbXUpIG5lZWRzIGFjY2VzcyB0byBhIGZpbGUgaXQgY2FuCitpbnRlcnByZXQg dG8gcHJvdmlkZSBlbXVsYXRlZCBkaXNrcyBiZWZvcmUgcGFyYXZpcnR1YWxpemVkIGRyaXZlcnMg YXJlCittYXJrZWQgYXMgdXAuICBUaGUgZWFzaWVzdCB3YXkgdG8gYWNjb21wbGlzaCB0aGlzIGlz IHRvIGFsbG93IHFlbXUgdG8KK2NvbnN1bWUgcGh5c2ljYWwtZGV2aWNlLXBhdGggKHJhdGhlciB0 aGFuLCBzYXksIGhhdmluZyBkb20wIGFjdCBhcworYm90aCBhIGZyb250ZW5kIGFuZCBhIGJhY2tl bmQpLgorCitHb2luZyBmb3J3YXJkLCB0aGUgcGxhbiBpcyBhdCBzb21lIHBvaW50IHRvIGhhdmUg YWxsIGJsb2NrIHNjcmlwdHMKK3NpbXBseSB3cml0ZSAicGh5c2ljYWwtZGV2aWNlLXBhdGgiLCBh bmQgdGhlbiBoYXZlIGxpYnhsIHdyaXRlIHRoZQorb3RoZXIgbm9kZXMuICBUaGUgcmVhc29uIHdl IGhhdmVuJ3QgZG9uZSB0aGlzIHlldCBpcyB0aGF0IHRoZSBtYWluCitibG9jayBzY3JpcHQgd2Fu dHMgdG8gY2hlY2sgdG8gbWFrZSBzdXJlIHRoZSAqbWFqb3IvbWlub3IqIG51bWJlcgoraGFzbid0 IGJlZW4gcmUtdXNlZCwgcmF0aGVyIHRoYW4ganVzdCBjaGVja2luZyB0aGF0IHRoZSAqc3BlY2lm aWMKK2RldmljZSBub2RlKiBpc24ndCByZS11c2VkLiAgVG8gZG8gdGhpcyBpdCBjdXJyZW50bHkg dXNlcworcGh5c2ljYWwtZGV2aWNlOyBhbmQgdG8gZG8gdGhpcyAqc2FmZWx5KiBpdCBuZWVkcyBw aHlzaWNhbC1kZXZpY2UgdG8KK2JlIHdyaXR0ZW4gd2l0aCB0aGUgbG9jayBoZWxkLgorCitUaGUg c2ltcGxlc3Qgc29sdXRpb24gZm9yIHNvcnRpbmcgdGhpcyBvdXQgd291bGQgYmUgdG8gaGF2ZSB0 aGUgYmxvY2sKK3NjcmlwdCB1c2UgcGh5c2ljYWwtZGV2aWNlIGlmIGl0J3MgcHJlc2VudCwgYnV0 IGlmIG5vdCwgdG8gZGlyZWN0bHkKK3N0YXQgcGh5c2ljYWwtZGV2aWNlLXBhdGguICBCdXQgdGhl cmUncyBub3QgdGltZSBiZWZvcmUgdGhlIDQuNworcmVsZWFzZSB0byBtYWtlIHN1cmUgYWxsIHRo YXQgd29ya3MuCisKK0Fub3RoZXIgcG9zc2liaWxpdHkgd291bGQgYmUgdG8gb25seSBjYWxsIG91 dCB0byBzY3JpcHRzIHdoZW4gdXNpbmcKK2N1c3RvbSBob3RwbHVnIHNjcmlwdHM7IGFuZCB3aGVu IGRvaW5nIGZpbGVzIG9yIHBoeXNpY2FsIGRldmljZXMsIHRvCitkbyB0aGUgZHVwbGljYXRlIGNo ZWNraW5nIGluc2lkZSBvZiBsaWJ4bCBpbnN0ZWFkLiAgVGhlIHJhdGlvbmFsZSBmb3IKK2RvaW5n IHRoaXMgaW4gYmxvY2sgc2NyaXB0cyByYXRoZXIgdGhhbiBpbiBsaWJ4bCBpc24ndCBjbGVhciBh dCB0aGVzCitwb2ludC4KLS0gCjIuMS40CgoKX19fX19fX19fX19fX19fX19fX19fX19fX19fX19f X19fX19fX19fX19fX19fX18KWGVuLWRldmVsIG1haWxpbmcgbGlzdApYZW4tZGV2ZWxAbGlzdHMu eGVuLm9yZwpodHRwOi8vbGlzdHMueGVuLm9yZy94ZW4tZGV2ZWwK